diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7de9ec9309..b8d36b5473 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -54766,7 +54766,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -79427,7 +79427,7 @@ "/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/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/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -131058,6 +131058,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178925,6 +178926,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179276,6 +179278,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179650,7 +179653,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -180062,6 +180065,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180349,7 +180353,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -180657,7 +180661,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -181012,6 +181016,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -191081,7 +191086,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -191153,7 +191158,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 93de2388ed..d524260f2f 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -40357,6 +40357,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -58098,9 +58100,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -95482,6 +95481,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -130358,6 +130358,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130627,6 +130628,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130908,7 +130910,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131219,6 +131221,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131440,7 +131443,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -131680,7 +131683,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131952,6 +131955,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -139120,7 +139124,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -139172,7 +139177,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 4c96fcc711..7b33063b4a 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -54691,7 +54691,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -79338,7 +79338,7 @@ "/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/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/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -130494,6 +130494,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178452,6 +178453,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178803,6 +178805,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179177,7 +179180,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -179589,6 +179592,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179876,7 +179880,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -180184,7 +180188,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -180539,6 +180543,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -190608,7 +190613,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -190680,7 +190685,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 7002d32aed..a6caaa9df0 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -40296,6 +40296,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -58023,9 +58025,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -95063,6 +95062,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -130014,6 +130014,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130283,6 +130284,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130564,7 +130566,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -130875,6 +130877,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131096,7 +131099,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -131336,7 +131339,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131608,6 +131611,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -138776,7 +138780,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -138828,7 +138833,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 98beafd16f..9a18433164 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -55026,7 +55026,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -79734,7 +79734,7 @@ "/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/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/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -131810,6 +131810,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180197,6 +180198,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180548,6 +180550,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180922,7 +180925,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -181334,6 +181337,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -181621,7 +181625,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -181929,7 +181933,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -182284,6 +182288,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -192353,7 +192358,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -192425,7 +192430,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 02f41ccb4e..fbc4f1aec2 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -40495,6 +40495,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -58286,9 +58288,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -95972,6 +95971,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -131275,6 +131275,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131544,6 +131545,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131825,7 +131827,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -132136,6 +132138,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -132357,7 +132360,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -132597,7 +132600,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -132869,6 +132872,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -140037,7 +140041,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -140089,7 +140094,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index b3a97bb718..836aca25f8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -123156,6 +123156,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -359542,6 +359543,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -360617,6 +360619,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -365663,6 +365666,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -365971,6 +365975,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -394253,7 +394258,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -733034,7 +733039,7 @@ "/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/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/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -975512,6 +975517,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -977997,6 +978003,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -980340,7 +980347,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -983051,6 +983058,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -985472,7 +985480,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -987912,7 +987920,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -990401,6 +990409,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1119267,7 +1119276,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1122446,7 +1122455,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 753f17532c..32977a5e69 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -32834,6 +32834,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -78713,6 +78714,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -111022,9 +111025,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -131031,6 +131031,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131363,6 +131364,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131700,8 +131702,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132066,6 +132068,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132342,8 +132345,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -132640,8 +132643,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132968,6 +132971,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -143718,7 +143722,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -143829,7 +143834,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 75e4733dcf..46ff9de314 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -118844,6 +118844,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -351832,6 +351833,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -352907,6 +352909,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -357729,6 +357732,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -358037,6 +358041,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -386081,7 +386086,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -718664,7 +718669,7 @@ "/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/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/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -955716,6 +955721,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -958189,6 +958195,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -960520,7 +960527,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -963219,6 +963226,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -965628,7 +965636,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -968056,7 +968064,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -970533,6 +970541,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1098411,7 +1098420,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1101578,7 +1101587,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 0a127ff5b6..f3a8f1b3fa 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -32478,6 +32478,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -78264,6 +78265,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -110464,9 +110467,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -130599,6 +130599,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130931,6 +130932,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131268,8 +131270,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -131634,6 +131636,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131910,8 +131913,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -132208,8 +132211,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132536,6 +132539,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -143286,7 +143290,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -143397,7 +143402,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index aa96f0c99c..7d06f8f832 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -125296,6 +125296,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -367719,6 +367720,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -368794,6 +368796,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -374129,6 +374132,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -374437,6 +374441,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -403077,7 +403082,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -748956,7 +748961,7 @@ "/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/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/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -999113,6 +999118,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1001623,6 +1001629,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1003991,7 +1003998,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1006727,6 +1006734,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1009173,7 +1009181,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1011638,7 +1011646,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1014152,6 +1014160,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1144654,7 +1144663,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1147858,7 +1147867,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 9932ba2762..e86bb7026f 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -33156,6 +33156,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -79369,6 +79370,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -111874,9 +111877,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -131996,6 +131996,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132328,6 +132329,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132665,8 +132667,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -133031,6 +133033,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -133307,8 +133310,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -133605,8 +133608,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -133933,6 +133936,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -144683,7 +144687,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -144794,7 +144799,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index b319fb2728..0807370051 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -42602,6 +42602,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -82041,7 +82042,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -82578,7 +82579,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -82587,7 +82588,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -82924,14 +82925,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -83518,14 +83519,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -83757,7 +83758,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -83766,7 +83767,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -84025,7 +84026,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -178650,6 +178651,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -202917,6 +202919,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -202987,6 +203292,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -425397,6 +426023,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -426472,6 +427099,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -431518,6 +432146,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -431826,6 +432455,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -460156,7 +460786,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -814639,7 +815269,7 @@ "/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-cloud@latest/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-cloud@latest/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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-cloud@latest/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -1068871,6 +1069501,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1071356,6 +1071987,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1073699,7 +1074331,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1076410,6 +1077042,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1078831,7 +1079464,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1081271,7 +1081904,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1083760,6 +1084393,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1249718,7 +1250352,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1252921,7 +1253555,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 32529f3d4f..99cbe2a775 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -16601,6 +16601,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -29195,9 +29196,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -29431,14 +29440,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29562,13 +29571,21 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -29826,13 +29843,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -29871,14 +29894,14 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29985,7 +30008,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -53916,6 +53939,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -53947,6 +54120,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -93708,6 +94038,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -128824,9 +129156,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -149250,6 +149579,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149582,6 +149912,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149919,8 +150250,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -150285,6 +150616,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150561,8 +150893,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -150859,8 +151191,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -151187,6 +151519,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -162908,7 +163241,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -163019,7 +163353,8 @@ webhooks: repositories_added: *933 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json index 5001190b2d..4d3cbb1d92 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -42469,6 +42469,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -81880,7 +81881,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -82417,7 +82418,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -82426,7 +82427,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -82763,14 +82764,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -83357,14 +83358,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -83596,7 +83597,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -83605,7 +83606,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -83864,7 +83865,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -174051,6 +174052,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -198309,6 +198311,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -198379,6 +198684,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -417388,6 +418014,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -418463,6 +419090,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -423285,6 +423913,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -423593,6 +424222,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -451685,7 +452315,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -799970,7 +800600,7 @@ "/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-cloud@latest/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-cloud@latest/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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-cloud@latest/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -1048704,6 +1049334,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1051177,6 +1051808,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1053508,7 +1054140,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1056207,6 +1056839,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1058616,7 +1059249,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1061044,7 +1061677,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1063521,6 +1064154,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1228311,7 +1228945,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1231502,7 +1232136,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml index d6484cfae4..d9f019d566 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -16549,6 +16549,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -29120,9 +29121,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -29356,14 +29365,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29487,13 +29496,21 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -29751,13 +29768,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -29796,14 +29819,14 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29910,7 +29933,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -53478,6 +53501,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -53509,6 +53682,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -93247,6 +93577,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -128254,9 +128586,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -148806,6 +149135,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149138,6 +149468,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149475,8 +149806,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -149841,6 +150172,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150117,8 +150449,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -150415,8 +150747,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -150743,6 +151075,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -162464,7 +162797,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -162575,7 +162909,8 @@ webhooks: repositories_added: *933 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.json b/descriptions-next/ghec/dereferenced/ghec.deref.json index 586b9a0a2e..7f7047aaa9 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.deref.json @@ -43049,6 +43049,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -82513,7 +82514,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -83050,7 +83051,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -83059,7 +83060,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -83396,14 +83397,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -83990,14 +83991,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -84229,7 +84230,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -84238,7 +84239,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -84497,7 +84498,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -181038,6 +181039,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205338,6 +205340,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -205408,6 +205713,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -433822,6 +434448,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -434897,6 +435524,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -440232,6 +440860,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -440540,6 +441169,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -469228,7 +469858,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -830809,7 +831439,7 @@ "/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-cloud@latest/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-cloud@latest/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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-cloud@latest/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -1092845,6 +1093475,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1095355,6 +1095986,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1097723,7 +1098355,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1100459,6 +1101091,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1102905,7 +1103538,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1105370,7 +1106003,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1107884,6 +1108517,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1275853,7 +1276487,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1279081,7 +1279715,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.deref.yaml index 7156cfd035..64f5fc7f83 100644 --- a/descriptions-next/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.deref.yaml @@ -16755,6 +16755,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -29368,9 +29369,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -29604,14 +29613,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29735,13 +29744,21 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -29999,13 +30016,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -30044,14 +30067,14 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -30158,7 +30181,7 @@ paths: '503': *196 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -54251,6 +54274,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -54282,6 +54455,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -94377,6 +94707,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -129689,9 +130021,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -150228,6 +150557,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150560,6 +150890,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150897,8 +151228,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -151263,6 +151594,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -151539,8 +151871,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -151837,8 +152169,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -152165,6 +152497,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -163886,7 +164219,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -163997,7 +164331,8 @@ webhooks: repositories_added: *933 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/ghec.2022-11-28.json b/descriptions-next/ghec/ghec.2022-11-28.json index 104279df4b..b9e5ada2b7 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.json +++ b/descriptions-next/ghec/ghec.2022-11-28.json @@ -18622,7 +18622,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -18816,7 +18816,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -18825,7 +18825,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -18864,14 +18864,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -19088,14 +19088,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -19134,7 +19134,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19143,7 +19143,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -19231,7 +19231,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39664,6 +39664,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39705,6 +39888,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -69586,7 +69958,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -96947,7 +97319,7 @@ "/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-cloud@latest/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-cloud@latest/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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-cloud@latest/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -144159,6 +144531,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204429,6 +204802,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204780,6 +205154,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205154,7 +205529,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -205566,6 +205941,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205853,7 +206229,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -206161,7 +206537,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -206516,6 +206892,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -216585,7 +216962,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -216657,7 +217034,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/ghec.2022-11-28.yaml b/descriptions-next/ghec/ghec.2022-11-28.yaml index 6f61be7ac0..0d4dde598e 100644 --- a/descriptions-next/ghec/ghec.2022-11-28.yaml +++ b/descriptions-next/ghec/ghec.2022-11-28.yaml @@ -13784,9 +13784,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -13937,14 +13945,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -13969,13 +13977,21 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -14137,13 +14153,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -14168,14 +14190,14 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -14233,7 +14255,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -29314,6 +29336,161 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -29346,6 +29523,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -51055,6 +51394,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -70714,9 +71055,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -104823,6 +105161,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -148817,6 +149156,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149086,6 +149426,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149367,7 +149708,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -149678,6 +150019,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149899,7 +150241,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -150139,7 +150481,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -150411,6 +150753,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -157579,7 +157922,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -157631,7 +157975,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/ghec.2026-03-10.json b/descriptions-next/ghec/ghec.2026-03-10.json index 625649b922..53d680b1a5 100644 --- a/descriptions-next/ghec/ghec.2026-03-10.json +++ b/descriptions-next/ghec/ghec.2026-03-10.json @@ -18622,7 +18622,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -18816,7 +18816,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -18825,7 +18825,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -18864,14 +18864,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -19088,14 +19088,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -19134,7 +19134,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19143,7 +19143,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -19231,7 +19231,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39602,6 +39602,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39643,6 +39826,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -69491,7 +69863,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -96838,7 +97210,7 @@ "/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-cloud@latest/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-cloud@latest/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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-cloud@latest/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -143959,6 +144331,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -203936,6 +204309,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204287,6 +204661,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -204661,7 +205036,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -205073,6 +205448,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205360,7 +205736,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -205668,7 +206044,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -206023,6 +206399,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -216092,7 +216469,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -216164,7 +216541,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/ghec.2026-03-10.yaml b/descriptions-next/ghec/ghec.2026-03-10.yaml index d997ece32b..9292fbb909 100644 --- a/descriptions-next/ghec/ghec.2026-03-10.yaml +++ b/descriptions-next/ghec/ghec.2026-03-10.yaml @@ -13784,9 +13784,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -13937,14 +13945,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -13969,13 +13977,21 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -14137,13 +14153,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -14168,14 +14190,14 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -14233,7 +14255,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -29267,6 +29289,161 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -29299,6 +29476,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -50981,6 +51320,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -70626,9 +70967,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -104662,6 +105000,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -148460,6 +148799,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -148729,6 +149069,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149010,7 +149351,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -149321,6 +149662,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -149542,7 +149884,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -149782,7 +150124,7 @@ components: "$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`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -150054,6 +150396,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -157222,7 +157565,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -157274,7 +157618,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/ghec.json b/descriptions-next/ghec/ghec.json index 6e71c5a4f9..07dd2f549a 100644 --- a/descriptions-next/ghec/ghec.json +++ b/descriptions-next/ghec/ghec.json @@ -18636,7 +18636,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -18830,7 +18830,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -18839,7 +18839,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -18878,14 +18878,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -19102,14 +19102,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -19148,7 +19148,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19157,7 +19157,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated actor must have permission to view enterprise billing.", "tags": [ "billing" ], @@ -19245,7 +19245,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39792,6 +39792,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39833,6 +40016,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\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` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -69872,7 +70244,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/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`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\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" ], @@ -97280,7 +97652,7 @@ "/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-cloud@latest/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-cloud@latest/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.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. 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 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-cloud@latest/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.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -144771,6 +145143,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -205727,6 +206100,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -206078,6 +206452,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -206452,7 +206827,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -206864,6 +207239,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -207151,7 +207527,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -207459,7 +207835,7 @@ "$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`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -207814,6 +208190,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -217883,7 +218260,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -217955,7 +218332,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/ghec.yaml b/descriptions-next/ghec/ghec.yaml index b7eb1d3d70..c4d75525e6 100644 --- a/descriptions-next/ghec/ghec.yaml +++ b/descriptions-next/ghec/ghec.yaml @@ -13792,9 +13792,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -13945,14 +13953,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -13977,13 +13985,21 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -14145,13 +14161,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -14176,14 +14198,14 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -14241,7 +14263,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -29382,6 +29404,161 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -29414,6 +29591,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -51207,6 +51546,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + 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)." @@ -70916,9 +71257,6 @@ paths: * 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 language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner{"code":"deadline_exceeded","msg":"operation timed out"}