diff --git a/descriptions/api.github.com/api.github.com.2022-11-28.json b/descriptions/api.github.com/api.github.com.2022-11-28.json index be57ad26b8..3dc84c08b5 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions/api.github.com/api.github.com.2022-11-28.json @@ -79055,7 +79055,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" ], @@ -129351,7 +129351,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "code-scanning-alert-dismissed-comment": { @@ -174532,6 +174533,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174866,6 +174868,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175214,7 +175217,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`.", "nullable": true }, "fixed_at": { @@ -175591,6 +175594,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175855,7 +175859,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", "nullable": true }, @@ -176130,7 +176134,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`.", "nullable": true }, "fixed_at": { @@ -176464,6 +176468,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -186263,7 +186268,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", @@ -186335,7 +186340,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/api.github.com/api.github.com.2022-11-28.yaml b/descriptions/api.github.com/api.github.com.2022-11-28.yaml index f3fb50bce0..ed5959007b 100644 --- a/descriptions/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions/api.github.com/api.github.com.2022-11-28.yaml @@ -57906,9 +57906,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 @@ -94887,6 +94884,7 @@ components: - false positive - won't fix - used in tests + - mitigated code-scanning-alert-dismissed-comment: type: string description: The dismissal comment associated with the dismissal of the alert. @@ -129568,6 +129566,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -129828,6 +129827,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130096,7 +130096,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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130389,6 +130389,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130598,7 +130599,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 nullable: true fixed_at: @@ -130821,7 +130822,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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131082,6 +131083,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -138114,7 +138116,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 @@ -138166,7 +138169,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/api.github.com/api.github.com.2026-03-10.json b/descriptions/api.github.com/api.github.com.2026-03-10.json index 9527f4f0a7..e72439e740 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions/api.github.com/api.github.com.2026-03-10.json @@ -78972,7 +78972,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" ], @@ -128855,7 +128855,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "code-scanning-alert-dismissed-comment": { @@ -174106,6 +174107,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174440,6 +174442,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174788,7 +174791,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`.", "nullable": true }, "fixed_at": { @@ -175165,6 +175168,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175429,7 +175433,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", "nullable": true }, @@ -175704,7 +175708,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`.", "nullable": true }, "fixed_at": { @@ -176038,6 +176042,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -185837,7 +185842,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", @@ -185909,7 +185914,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/api.github.com/api.github.com.2026-03-10.yaml b/descriptions/api.github.com/api.github.com.2026-03-10.yaml index fbec46e368..27ed6b6949 100644 --- a/descriptions/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions/api.github.com/api.github.com.2026-03-10.yaml @@ -57834,9 +57834,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 @@ -94495,6 +94492,7 @@ components: - false positive - won't fix - used in tests + - mitigated code-scanning-alert-dismissed-comment: type: string description: The dismissal comment associated with the dismissal of the alert. @@ -129222,6 +129220,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -129482,6 +129481,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -129750,7 +129750,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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130043,6 +130043,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130252,7 +130253,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 nullable: true fixed_at: @@ -130475,7 +130476,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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130736,6 +130737,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -137768,7 +137770,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 @@ -137820,7 +137823,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/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index a248592518..93fffd06a7 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -79362,7 +79362,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" ], @@ -130103,7 +130103,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "code-scanning-alert-dismissed-comment": { @@ -176003,6 +176004,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -176337,6 +176339,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -176685,7 +176688,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`.", "nullable": true }, "fixed_at": { @@ -177062,6 +177065,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -177326,7 +177330,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", "nullable": true }, @@ -177601,7 +177605,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`.", "nullable": true }, "fixed_at": { @@ -177935,6 +177939,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -187734,7 +187739,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", @@ -187806,7 +187811,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/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 9f435d4553..f44e9645f9 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -58094,9 +58094,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 @@ -95377,6 +95374,7 @@ components: - false positive - won't fix - used in tests + - mitigated code-scanning-alert-dismissed-comment: type: string description: The dismissal comment associated with the dismissal of the alert. @@ -130637,6 +130635,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130897,6 +130896,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131165,7 +131165,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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131458,6 +131458,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131667,7 +131668,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 nullable: true fixed_at: @@ -131890,7 +131891,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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -132151,6 +132152,7 @@ components: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -139183,7 +139185,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 @@ -139235,7 +139238,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index 13ab650aa7..89c13e5e2a 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -107367,7 +107367,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -311221,7 +311222,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -312116,7 +312118,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -316055,7 +316058,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -316301,7 +316305,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -618989,7 +618994,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" ], @@ -820067,6 +820072,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -822119,6 +822125,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -824064,7 +824071,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`.", "nullable": true }, "fixed_at": { @@ -826280,6 +826287,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -828262,7 +828270,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", "nullable": true }, @@ -830253,7 +830261,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`.", "nullable": true }, "fixed_at": { @@ -832305,6 +832313,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -940231,7 +940240,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", @@ -942893,7 +942902,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/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index e632daa3bd..dee848bcff 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -31958,6 +31958,7 @@ paths: - false positive - won't fix - used in tests + - mitigated dismissed_comment: &452 type: string description: The dismissal comment associated with the dismissal @@ -108884,9 +108885,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 @@ -128527,6 +128525,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -128850,6 +128849,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129174,8 +129174,8 @@ x-webhooks: dismissed_comment: *452 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129522,6 +129522,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129786,8 +129787,8 @@ x-webhooks: dismissed_comment: *452 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 nullable: true fixed_at: @@ -130067,8 +130068,8 @@ x-webhooks: dismissed_comment: *452 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130384,6 +130385,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -140988,7 +140990,8 @@ x-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 @@ -141099,7 +141102,8 @@ x-webhooks: repositories_added: *823 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/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index a65573277f..ff09a482d2 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -103936,7 +103936,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -305089,7 +305090,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -305984,7 +305986,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -309757,7 +309760,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -310003,7 +310007,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -607729,7 +607734,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" ], @@ -804552,6 +804557,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -806592,6 +806598,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -808525,7 +808532,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`.", "nullable": true }, "fixed_at": { @@ -810729,6 +810736,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -812699,7 +812707,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", "nullable": true }, @@ -814678,7 +814686,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`.", "nullable": true }, "fixed_at": { @@ -816718,6 +816726,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -923730,7 +923739,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", @@ -926380,7 +926389,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/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 705caffc8e..642cd869c4 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -31612,6 +31612,7 @@ paths: - false positive - won't fix - used in tests + - mitigated dismissed_comment: &452 type: string description: The dismissal comment associated with the dismissal @@ -108342,9 +108343,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 @@ -128093,6 +128091,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -128416,6 +128415,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -128740,8 +128740,8 @@ x-webhooks: dismissed_comment: *452 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129088,6 +129088,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129352,8 +129353,8 @@ x-webhooks: dismissed_comment: *452 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 nullable: true fixed_at: @@ -129633,8 +129634,8 @@ x-webhooks: dismissed_comment: *452 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129950,6 +129951,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -140554,7 +140556,8 @@ x-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 @@ -140665,7 +140668,8 @@ x-webhooks: repositories_added: *823 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/api.github.com/dereferenced/api.github.com.deref.json b/descriptions/api.github.com/dereferenced/api.github.com.deref.json index 5cbd524a06..234bb4ccc9 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.json @@ -109501,7 +109501,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -318846,7 +318847,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -319741,7 +319743,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -323969,7 +323972,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -324215,7 +324219,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -634359,7 +634364,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" ], @@ -842576,6 +842581,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -844653,6 +844659,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -846623,7 +846630,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`.", "nullable": true }, "fixed_at": { @@ -848864,6 +848871,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -850871,7 +850879,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", "nullable": true }, @@ -852887,7 +852895,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`.", "nullable": true }, "fixed_at": { @@ -854964,6 +854972,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -964526,7 +964535,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", @@ -967213,7 +967222,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/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml index 033ffbf47b..cff5ee9a64 100644 --- a/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions/api.github.com/dereferenced/api.github.com.deref.yaml @@ -32280,6 +32280,7 @@ paths: - false positive - won't fix - used in tests + - mitigated dismissed_comment: &454 type: string description: The dismissal comment associated with the dismissal @@ -109739,9 +109740,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 @@ -129495,6 +129493,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -129818,6 +129817,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130142,8 +130142,8 @@ x-webhooks: dismissed_comment: *454 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130490,6 +130490,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130754,8 +130755,8 @@ x-webhooks: dismissed_comment: *454 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 nullable: true fixed_at: @@ -131035,8 +131036,8 @@ x-webhooks: dismissed_comment: *454 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131352,6 +131353,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -141956,7 +141958,8 @@ x-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 @@ -142067,7 +142070,8 @@ x-webhooks: repositories_added: *826 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/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json index 5846ed4d10..4936834427 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -39087,7 +39087,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -76422,7 +76423,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" ], @@ -76737,7 +76738,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -77539,7 +77540,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" ], @@ -77798,7 +77799,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -159084,7 +159085,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -180859,283 +180861,898 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" - } - } - }, - "/orgs/{org}/credential-authorizations": { - "get": { - "summary": "List SAML SSO authorizations for an organization", - "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials can be personal access tokens, SSH keys, OAuth app access tokens, or user-to-server tokens from GitHub Apps that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-saml-sso-authorizations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page token", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "login", - "description": "Limits the list of credentials authorizations for an organization to a specific login", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Credential Authorization", - "description": "Credential Authorization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "monalisa", - "description": "User login that owns the underlying credential." - }, - "credential_id": { - "type": "integer", - "example": 1, - "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key." - }, - "credential_type": { - "type": "string", - "example": "SSH key", - "description": "Human-readable description of the credential type.", - "enum": [ - "personal access token", - "SSH key", - "OAuth app token", - "GitHub app token" - ] - }, - "token_last_eight": { - "type": "string", - "example": "12345678", - "description": "Last eight characters of the credential. Only included in responses with a credential_type of personal access token, OAuth app token, or GitHub app token." - }, - "credential_authorized_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "description": "Date when the credential was authorized for use." - }, - "scopes": { - "type": "array", - "example": [ - "user", - "repo" - ], - "description": "List of OAuth scopes the token has been granted.", - "items": { - "type": "string" - } - }, - "fingerprint": { - "type": "string", - "example": "jklmnop12345678", - "description": "Unique string to distinguish the credential. Only included in responses with a credential_type of SSH key." - }, - "credential_accessed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "description": "Date when the credential was last accessed. May be null if it was never accessed", - "nullable": true - }, - "authorized_credential_id": { - "type": "integer", - "nullable": true, - "example": 12345678, - "description": "The ID of the underlying token or key that was authorized by the user. This will remain unchanged across authorizations of the token or key." - }, - "authorized_credential_title": { - "type": "string", - "nullable": true, - "example": "my ssh key", - "description": "The title given to the ssh key. This will only be present when the credential is an ssh key." - }, - "authorized_credential_note": { - "type": "string", - "nullable": true, - "example": "my token", - "description": "The note given to the token. This will only be present when the credential is a token." - }, - "authorized_credential_expires_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The expiry for the token. This will only be present when the credential is a token." - } - }, - "required": [ - "login", - "credential_id", - "credential_type", - "credential_authorized_at", - "credential_accessed_at", - "authorized_credential_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "credential_id": 161195, - "credential_type": "personal access token", - "token_last_eight": "71c3fc11", - "credential_authorized_at": "2011-01-26T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_id": 12345678, - "authorized_credential_expires_at": "2011-02-25T19:06:43Z", - "scopes": [ - "user", - "repo" - ] - }, - { - "login": "hubot", - "credential_id": 161196, - "credential_type": "personal access token", - "token_last_eight": "Ae178B4a", - "credential_authorized_at": "2019-03-29T19:06:43Z", - "credential_accessed_at": "2019-04-15T19:06:43Z", - "authorized_credential_id": 12345679, - "authorized_credential_expires_at": "2019-04-28T19:06:43Z", - "scopes": [ - "repo" - ] - }, - { - "login": "octocat", - "credential_id": 161197, - "credential_type": "OAuth app token", - "token_last_eight": "9f2c4d1e", - "credential_authorized_at": "2023-05-15T19:06:43Z", - "credential_accessed_at": "2023-05-16T19:06:43Z", - "authorized_credential_id": 12345680, - "authorized_credential_expires_at": "2023-06-14T19:06:43Z", - "scopes": [ - "repo", - "read:org" - ] - }, - { - "login": "hubot", - "credential_id": 161198, - "credential_type": "GitHub app token", - "token_last_eight": "3b7a0c52", - "credential_authorized_at": "2023-05-15T19:06:43Z", - "credential_accessed_at": "2023-05-16T19:06:43Z", - "authorized_credential_id": 12345681, - "authorized_credential_expires_at": "2023-06-14T19:06:43Z", - "scopes": [] - }, - { - "login": "octocat", - "credential_id": 161199, - "credential_type": "SSH key", - "credential_authorized_at": "2023-05-15T19:06:43Z", - "credential_accessed_at": "2023-05-16T19:06:43Z", - "authorized_credential_id": 12345682, - "fingerprint": "jklmnop12345678", - "authorized_credential_title": "my ssh key" - } - ] - } - } - } - } - } - }, - "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", - "description": "Removes a credential authorization for an organization that uses SAML SSO. The credential can be a personal access token, an SSH key, an OAuth app access token, or a user-to-server token from a GitHub App. Once you remove someone's credential authorization, they will need to authorize the credential again for the organization they want to access.\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/remove-saml-sso-authorization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/credential-authorizations": { + "get": { + "summary": "List SAML SSO authorizations for an organization", + "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials can be personal access tokens, SSH keys, OAuth app access tokens, or user-to-server tokens from GitHub Apps that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-saml-sso-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "login", + "description": "Limits the list of credentials authorizations for an organization to a specific login", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Credential Authorization", + "description": "Credential Authorization", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "monalisa", + "description": "User login that owns the underlying credential." + }, + "credential_id": { + "type": "integer", + "example": 1, + "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key." + }, + "credential_type": { + "type": "string", + "example": "SSH key", + "description": "Human-readable description of the credential type.", + "enum": [ + "personal access token", + "SSH key", + "OAuth app token", + "GitHub app token" + ] + }, + "token_last_eight": { + "type": "string", + "example": "12345678", + "description": "Last eight characters of the credential. Only included in responses with a credential_type of personal access token, OAuth app token, or GitHub app token." + }, + "credential_authorized_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "Date when the credential was authorized for use." + }, + "scopes": { + "type": "array", + "example": [ + "user", + "repo" + ], + "description": "List of OAuth scopes the token has been granted.", + "items": { + "type": "string" + } + }, + "fingerprint": { + "type": "string", + "example": "jklmnop12345678", + "description": "Unique string to distinguish the credential. Only included in responses with a credential_type of SSH key." + }, + "credential_accessed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "Date when the credential was last accessed. May be null if it was never accessed", + "nullable": true + }, + "authorized_credential_id": { + "type": "integer", + "nullable": true, + "example": 12345678, + "description": "The ID of the underlying token or key that was authorized by the user. This will remain unchanged across authorizations of the token or key." + }, + "authorized_credential_title": { + "type": "string", + "nullable": true, + "example": "my ssh key", + "description": "The title given to the ssh key. This will only be present when the credential is an ssh key." + }, + "authorized_credential_note": { + "type": "string", + "nullable": true, + "example": "my token", + "description": "The note given to the token. This will only be present when the credential is a token." + }, + "authorized_credential_expires_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The expiry for the token. This will only be present when the credential is a token." + } + }, + "required": [ + "login", + "credential_id", + "credential_type", + "credential_authorized_at", + "credential_accessed_at", + "authorized_credential_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "credential_id": 161195, + "credential_type": "personal access token", + "token_last_eight": "71c3fc11", + "credential_authorized_at": "2011-01-26T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_id": 12345678, + "authorized_credential_expires_at": "2011-02-25T19:06:43Z", + "scopes": [ + "user", + "repo" + ] + }, + { + "login": "hubot", + "credential_id": 161196, + "credential_type": "personal access token", + "token_last_eight": "Ae178B4a", + "credential_authorized_at": "2019-03-29T19:06:43Z", + "credential_accessed_at": "2019-04-15T19:06:43Z", + "authorized_credential_id": 12345679, + "authorized_credential_expires_at": "2019-04-28T19:06:43Z", + "scopes": [ + "repo" + ] + }, + { + "login": "octocat", + "credential_id": 161197, + "credential_type": "OAuth app token", + "token_last_eight": "9f2c4d1e", + "credential_authorized_at": "2023-05-15T19:06:43Z", + "credential_accessed_at": "2023-05-16T19:06:43Z", + "authorized_credential_id": 12345680, + "authorized_credential_expires_at": "2023-06-14T19:06:43Z", + "scopes": [ + "repo", + "read:org" + ] + }, + { + "login": "hubot", + "credential_id": 161198, + "credential_type": "GitHub app token", + "token_last_eight": "3b7a0c52", + "credential_authorized_at": "2023-05-15T19:06:43Z", + "credential_accessed_at": "2023-05-16T19:06:43Z", + "authorized_credential_id": 12345681, + "authorized_credential_expires_at": "2023-06-14T19:06:43Z", + "scopes": [] + }, + { + "login": "octocat", + "credential_id": 161199, + "credential_type": "SSH key", + "credential_authorized_at": "2023-05-15T19:06:43Z", + "credential_accessed_at": "2023-05-16T19:06:43Z", + "authorized_credential_id": 12345682, + "fingerprint": "jklmnop12345678", + "authorized_credential_title": "my ssh key" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "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\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", + "description": "Removes a credential authorization for an organization that uses SAML SSO. The credential can be a personal access token, an SSH key, an OAuth app access token, or a user-to-server token from a GitHub App. Once you remove someone's credential authorization, they will need to authorize the credential again for the organization they want to access.\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/remove-saml-sso-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credential_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "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": { + "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" + } + } + } + } + } }, - { - "name": "credential_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", "content": { "application/json": { "schema": { @@ -181156,6 +181773,15 @@ "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" + } + } } } } @@ -372541,7 +373167,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -373436,7 +374063,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -377375,7 +378003,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -377621,7 +378250,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -694501,7 +695131,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" ], @@ -905403,6 +906033,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -907455,6 +908086,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -909400,7 +910032,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`.", "nullable": true }, "fixed_at": { @@ -911616,6 +912248,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -913598,7 +914231,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", "nullable": true }, @@ -915589,7 +916222,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`.", "nullable": true }, "fixed_at": { @@ -917641,6 +918274,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1056887,7 +1057521,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", @@ -1059573,7 +1060207,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/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 883e126c87..fa5f6de139 100644 --- a/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -16159,6 +16159,7 @@ paths: - false positive - won't fix - used in tests + - mitigated dismissed_comment: &588 type: string description: The dismissal comment associated with the dismissal @@ -28718,8 +28719,8 @@ paths: "/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 @@ -28836,7 +28837,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: @@ -29143,7 +29144,7 @@ paths: 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 @@ -29250,7 +29251,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -52704,6 +52705,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: + - *90 + 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': *29 + '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: + - *90 + 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': *29 + '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 @@ -52735,6 +52886,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: + - *90 + - *135 + 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': *29 + '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: + - *90 + - *135 + 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': *29 + '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 @@ -126393,9 +126701,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 @@ -146442,6 +146747,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -146765,6 +147071,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -147089,8 +147396,8 @@ x-webhooks: dismissed_comment: *588 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -147437,6 +147744,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -147701,8 +148009,8 @@ x-webhooks: dismissed_comment: *588 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 nullable: true fixed_at: @@ -147982,8 +148290,8 @@ x-webhooks: dismissed_comment: *588 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -148299,6 +148607,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -159874,7 +160183,8 @@ x-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 @@ -159985,7 +160295,8 @@ x-webhooks: repositories_added: *967 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/ghec/dereferenced/ghec.2026-03-10.deref.json b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json index 02dcad502b..fba19a4b9b 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.json @@ -38972,7 +38972,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -76281,7 +76282,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" ], @@ -76596,7 +76597,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -77398,7 +77399,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" ], @@ -77657,7 +77658,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -155418,7 +155419,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -177184,283 +177186,898 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "category": "copilot", - "subcategory": "copilot-usage-metrics" - } - } - }, - "/orgs/{org}/credential-authorizations": { - "get": { - "summary": "List SAML SSO authorizations for an organization", - "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials can be personal access tokens, SSH keys, OAuth app access tokens, or user-to-server tokens from GitHub Apps that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-saml-sso-authorizations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page token", - "in": "query", - "schema": { - "type": "integer" - } - }, - { - "name": "login", - "description": "Limits the list of credentials authorizations for an organization to a specific login", - "in": "query", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "Response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Credential Authorization", - "description": "Credential Authorization", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "monalisa", - "description": "User login that owns the underlying credential." - }, - "credential_id": { - "type": "integer", - "example": 1, - "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key." - }, - "credential_type": { - "type": "string", - "example": "SSH key", - "description": "Human-readable description of the credential type.", - "enum": [ - "personal access token", - "SSH key", - "OAuth app token", - "GitHub app token" - ] - }, - "token_last_eight": { - "type": "string", - "example": "12345678", - "description": "Last eight characters of the credential. Only included in responses with a credential_type of personal access token, OAuth app token, or GitHub app token." - }, - "credential_authorized_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "description": "Date when the credential was authorized for use." - }, - "scopes": { - "type": "array", - "example": [ - "user", - "repo" - ], - "description": "List of OAuth scopes the token has been granted.", - "items": { - "type": "string" - } - }, - "fingerprint": { - "type": "string", - "example": "jklmnop12345678", - "description": "Unique string to distinguish the credential. Only included in responses with a credential_type of SSH key." - }, - "credential_accessed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "description": "Date when the credential was last accessed. May be null if it was never accessed", - "nullable": true - }, - "authorized_credential_id": { - "type": "integer", - "nullable": true, - "example": 12345678, - "description": "The ID of the underlying token or key that was authorized by the user. This will remain unchanged across authorizations of the token or key." - }, - "authorized_credential_title": { - "type": "string", - "nullable": true, - "example": "my ssh key", - "description": "The title given to the ssh key. This will only be present when the credential is an ssh key." - }, - "authorized_credential_note": { - "type": "string", - "nullable": true, - "example": "my token", - "description": "The note given to the token. This will only be present when the credential is a token." - }, - "authorized_credential_expires_at": { - "type": "string", - "format": "date-time", - "nullable": true, - "description": "The expiry for the token. This will only be present when the credential is a token." - } - }, - "required": [ - "login", - "credential_id", - "credential_type", - "credential_authorized_at", - "credential_accessed_at", - "authorized_credential_id" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "credential_id": 161195, - "credential_type": "personal access token", - "token_last_eight": "71c3fc11", - "credential_authorized_at": "2011-01-26T19:06:43Z", - "credential_accessed_at": "2011-01-26T19:06:43Z", - "authorized_credential_id": 12345678, - "authorized_credential_expires_at": "2011-02-25T19:06:43Z", - "scopes": [ - "user", - "repo" - ] - }, - { - "login": "hubot", - "credential_id": 161196, - "credential_type": "personal access token", - "token_last_eight": "Ae178B4a", - "credential_authorized_at": "2019-03-29T19:06:43Z", - "credential_accessed_at": "2019-04-15T19:06:43Z", - "authorized_credential_id": 12345679, - "authorized_credential_expires_at": "2019-04-28T19:06:43Z", - "scopes": [ - "repo" - ] - }, - { - "login": "octocat", - "credential_id": 161197, - "credential_type": "OAuth app token", - "token_last_eight": "9f2c4d1e", - "credential_authorized_at": "2023-05-15T19:06:43Z", - "credential_accessed_at": "2023-05-16T19:06:43Z", - "authorized_credential_id": 12345680, - "authorized_credential_expires_at": "2023-06-14T19:06:43Z", - "scopes": [ - "repo", - "read:org" - ] - }, - { - "login": "hubot", - "credential_id": 161198, - "credential_type": "GitHub app token", - "token_last_eight": "3b7a0c52", - "credential_authorized_at": "2023-05-15T19:06:43Z", - "credential_accessed_at": "2023-05-16T19:06:43Z", - "authorized_credential_id": 12345681, - "authorized_credential_expires_at": "2023-06-14T19:06:43Z", - "scopes": [] - }, - { - "login": "octocat", - "credential_id": 161199, - "credential_type": "SSH key", - "credential_authorized_at": "2023-05-15T19:06:43Z", - "credential_accessed_at": "2023-05-16T19:06:43Z", - "authorized_credential_id": 12345682, - "fingerprint": "jklmnop12345678", - "authorized_credential_title": "my ssh key" - } - ] - } - } - } - } - } - }, - "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", - "description": "Removes a credential authorization for an organization that uses SAML SSO. The credential can be a personal access token, an SSH key, an OAuth app access token, or a user-to-server token from a GitHub App. Once you remove someone's credential authorization, they will need to authorize the credential again for the organization they want to access.\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/remove-saml-sso-authorization", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "description": "The organization name. The name is not case sensitive.", - "in": "path", - "required": true, - "schema": { - "type": "string" - } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "category": "copilot", + "subcategory": "copilot-usage-metrics" + } + } + }, + "/orgs/{org}/credential-authorizations": { + "get": { + "summary": "List SAML SSO authorizations for an organization", + "description": "Lists all credential authorizations for an organization that uses SAML single sign-on (SSO). The credentials can be personal access tokens, SSH keys, OAuth app access tokens, or user-to-server tokens from GitHub Apps that organization members have authorized for the organization. For more information, see [About authentication with SAML single sign-on](https://docs.github.com/enterprise-cloud@latest/articles/about-authentication-with-saml-single-sign-on).\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `read:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-saml-sso-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#list-saml-sso-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "The number of results per page (max 100). For more information, see \"[Using pagination in the REST API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/using-pagination-in-the-rest-api).\"", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page token", + "in": "query", + "schema": { + "type": "integer" + } + }, + { + "name": "login", + "description": "Limits the list of credentials authorizations for an organization to a specific login", + "in": "query", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "Response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Credential Authorization", + "description": "Credential Authorization", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "monalisa", + "description": "User login that owns the underlying credential." + }, + "credential_id": { + "type": "integer", + "example": 1, + "description": "Unique identifier for the authorization of the credential. Use this to revoke authorization of the underlying token or key." + }, + "credential_type": { + "type": "string", + "example": "SSH key", + "description": "Human-readable description of the credential type.", + "enum": [ + "personal access token", + "SSH key", + "OAuth app token", + "GitHub app token" + ] + }, + "token_last_eight": { + "type": "string", + "example": "12345678", + "description": "Last eight characters of the credential. Only included in responses with a credential_type of personal access token, OAuth app token, or GitHub app token." + }, + "credential_authorized_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "Date when the credential was authorized for use." + }, + "scopes": { + "type": "array", + "example": [ + "user", + "repo" + ], + "description": "List of OAuth scopes the token has been granted.", + "items": { + "type": "string" + } + }, + "fingerprint": { + "type": "string", + "example": "jklmnop12345678", + "description": "Unique string to distinguish the credential. Only included in responses with a credential_type of SSH key." + }, + "credential_accessed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "description": "Date when the credential was last accessed. May be null if it was never accessed", + "nullable": true + }, + "authorized_credential_id": { + "type": "integer", + "nullable": true, + "example": 12345678, + "description": "The ID of the underlying token or key that was authorized by the user. This will remain unchanged across authorizations of the token or key." + }, + "authorized_credential_title": { + "type": "string", + "nullable": true, + "example": "my ssh key", + "description": "The title given to the ssh key. This will only be present when the credential is an ssh key." + }, + "authorized_credential_note": { + "type": "string", + "nullable": true, + "example": "my token", + "description": "The note given to the token. This will only be present when the credential is a token." + }, + "authorized_credential_expires_at": { + "type": "string", + "format": "date-time", + "nullable": true, + "description": "The expiry for the token. This will only be present when the credential is a token." + } + }, + "required": [ + "login", + "credential_id", + "credential_type", + "credential_authorized_at", + "credential_accessed_at", + "authorized_credential_id" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "credential_id": 161195, + "credential_type": "personal access token", + "token_last_eight": "71c3fc11", + "credential_authorized_at": "2011-01-26T19:06:43Z", + "credential_accessed_at": "2011-01-26T19:06:43Z", + "authorized_credential_id": 12345678, + "authorized_credential_expires_at": "2011-02-25T19:06:43Z", + "scopes": [ + "user", + "repo" + ] + }, + { + "login": "hubot", + "credential_id": 161196, + "credential_type": "personal access token", + "token_last_eight": "Ae178B4a", + "credential_authorized_at": "2019-03-29T19:06:43Z", + "credential_accessed_at": "2019-04-15T19:06:43Z", + "authorized_credential_id": 12345679, + "authorized_credential_expires_at": "2019-04-28T19:06:43Z", + "scopes": [ + "repo" + ] + }, + { + "login": "octocat", + "credential_id": 161197, + "credential_type": "OAuth app token", + "token_last_eight": "9f2c4d1e", + "credential_authorized_at": "2023-05-15T19:06:43Z", + "credential_accessed_at": "2023-05-16T19:06:43Z", + "authorized_credential_id": 12345680, + "authorized_credential_expires_at": "2023-06-14T19:06:43Z", + "scopes": [ + "repo", + "read:org" + ] + }, + { + "login": "hubot", + "credential_id": 161198, + "credential_type": "GitHub app token", + "token_last_eight": "3b7a0c52", + "credential_authorized_at": "2023-05-15T19:06:43Z", + "credential_accessed_at": "2023-05-16T19:06:43Z", + "authorized_credential_id": 12345681, + "authorized_credential_expires_at": "2023-06-14T19:06:43Z", + "scopes": [] + }, + { + "login": "octocat", + "credential_id": 161199, + "credential_type": "SSH key", + "credential_authorized_at": "2023-05-15T19:06:43Z", + "credential_accessed_at": "2023-05-16T19:06:43Z", + "authorized_credential_id": 12345682, + "fingerprint": "jklmnop12345678", + "authorized_credential_title": "my ssh key" + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "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\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", + "description": "Removes a credential authorization for an organization that uses SAML SSO. The credential can be a personal access token, an SSH key, an OAuth app access token, or a user-to-server token from a GitHub App. Once you remove someone's credential authorization, they will need to authorize the credential again for the organization they want to access.\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/remove-saml-sso-authorization", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#remove-a-saml-sso-authorization-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "credential_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Response" + }, + "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": { + "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" + } + } + } + } + } }, - { - "name": "credential_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Response" - }, - "404": { - "description": "Resource not found", + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", "content": { "application/json": { "schema": { @@ -177481,6 +178098,15 @@ "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" + } + } } } } @@ -366162,7 +366788,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -367057,7 +367684,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -370830,7 +371458,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -371076,7 +371705,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -682994,7 +683624,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" ], @@ -889569,6 +890199,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -891609,6 +892240,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -893542,7 +894174,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`.", "nullable": true }, "fixed_at": { @@ -895746,6 +896378,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -897716,7 +898349,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", "nullable": true }, @@ -899695,7 +900328,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`.", "nullable": true }, "fixed_at": { @@ -901735,6 +902368,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1039887,7 +1040521,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", @@ -1042561,7 +1043195,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/ghec/dereferenced/ghec.2026-03-10.deref.yaml b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml index 19c9f7af5d..b591345971 100644 --- a/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.2026-03-10.deref.yaml @@ -16111,6 +16111,7 @@ paths: - false positive - won't fix - used in tests + - mitigated dismissed_comment: &588 type: string description: The dismissal comment associated with the dismissal @@ -28648,8 +28649,8 @@ paths: "/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 @@ -28766,7 +28767,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: @@ -29073,7 +29074,7 @@ paths: 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 @@ -29180,7 +29181,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -52278,6 +52279,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: + - *90 + 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': *29 + '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: + - *90 + 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': *29 + '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 @@ -52309,6 +52460,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: + - *90 + - *135 + 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': *29 + '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: + - *90 + - *135 + 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': *29 + '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 @@ -125840,9 +126148,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 @@ -145997,6 +146302,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -146320,6 +146626,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -146644,8 +146951,8 @@ x-webhooks: dismissed_comment: *588 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`.' nullable: true fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -146992,6 +147299,7 @@ x-webhooks: - false positive - won't fix - used in tests + - mitigated - null fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -147256,8 +147564,8 @@ x-webhooks: dismissed_comment: *588 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 nullable: true fixed_at: @@ -147537,8 +147845,8 @@ x-webhooks: dismissed_comment: *588 dismissed_reason: description: 'The reason for dismissing or closing the a{"code":"deadline_exceeded","msg":"operation timed out"}