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..50f7b238d2 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 @@ -54534,7 +54534,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -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": { @@ -140399,12 +140400,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -140852,6 +140855,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -140867,6 +140871,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -174532,6 +174537,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174866,6 +174872,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175214,7 +175221,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 +175598,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175855,7 +175863,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 +176138,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 +176472,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -186263,7 +186272,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 +186344,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", @@ -341399,7 +341408,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -341479,7 +341489,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "workflow-run-head-sha": { @@ -341550,7 +341561,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { 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..70a643d904 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 @@ -40240,6 +40240,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -57906,9 +57908,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 +94886,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. @@ -103607,10 +103607,12 @@ components: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -103980,6 +103982,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -103992,6 +103995,7 @@ components: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -129568,6 +129572,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 +129833,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 +130102,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 +130395,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 +130605,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 +130828,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 +131089,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 +138122,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 +138175,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 @@ -259296,6 +259306,7 @@ components: required: true schema: type: integer + format: int64 actor: name: actor description: Returns someone's workflow runs. Use the login for the user who @@ -259369,6 +259380,7 @@ components: in: query schema: type: integer + format: int64 workflow-run-head-sha: name: head_sha description: Only returns workflow runs that are associated with the specified @@ -259424,6 +259436,7 @@ components: required: true schema: type: integer + format: int64 check-suite-id: name: check_suite_id description: The unique identifier of the check suite. 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..0a7c14b27a 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 @@ -54461,7 +54461,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -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": { @@ -139830,12 +139831,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -140283,6 +140286,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -140298,6 +140302,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -174106,6 +174111,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174440,6 +174446,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174788,7 +174795,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 +175172,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175429,7 +175437,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 +175712,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 +176046,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -185837,7 +185846,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 +185918,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", @@ -340539,7 +340548,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -340619,7 +340629,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "workflow-run-head-sha": { @@ -340690,7 +340701,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { 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..84d21aed2d 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 @@ -40180,6 +40180,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -57834,9 +57836,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 +94494,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. @@ -103155,10 +103155,12 @@ components: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -103528,6 +103530,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -103540,6 +103543,7 @@ components: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -129222,6 +129226,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 +129487,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 +129756,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 +130049,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 +130259,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 +130482,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 +130743,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 +137776,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 +137829,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 @@ -258514,6 +258524,7 @@ components: required: true schema: type: integer + format: int64 actor: name: actor description: Returns someone's workflow runs. Use the login for the user who @@ -258587,6 +258598,7 @@ components: in: query schema: type: integer + format: int64 workflow-run-head-sha: name: head_sha description: Only returns workflow runs that are associated with the specified @@ -258642,6 +258654,7 @@ components: required: true schema: type: integer + format: int64 check-suite-id: name: check_suite_id description: The unique identifier of the check suite. diff --git a/descriptions/api.github.com/api.github.com.json b/descriptions/api.github.com/api.github.com.json index a248592518..701c6e70eb 100644 --- a/descriptions/api.github.com/api.github.com.json +++ b/descriptions/api.github.com/api.github.com.json @@ -54794,7 +54794,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -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": { @@ -141524,12 +141525,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -141977,6 +141980,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -141992,6 +141996,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -176003,6 +176008,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -176337,6 +176343,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -176685,7 +176692,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 +177069,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -177326,7 +177334,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 +177609,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 +177943,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -187734,7 +187743,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 +187815,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", @@ -343740,7 +343749,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -343820,7 +343830,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "workflow-run-head-sha": { @@ -343891,7 +343902,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { diff --git a/descriptions/api.github.com/api.github.com.yaml b/descriptions/api.github.com/api.github.com.yaml index 9f435d4553..097f2c49e9 100644 --- a/descriptions/api.github.com/api.github.com.yaml +++ b/descriptions/api.github.com/api.github.com.yaml @@ -40378,6 +40378,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -58094,9 +58096,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 +95376,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. @@ -104406,10 +104406,12 @@ components: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -104779,6 +104781,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -104791,6 +104794,7 @@ components: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -130637,6 +130641,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 +130902,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 +131171,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 +131464,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 +131674,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 +131897,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 +132158,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 +139191,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 +139244,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 @@ -260801,6 +260811,7 @@ components: required: true schema: type: integer + format: int64 actor: name: actor description: Returns someone's workflow runs. Use the login for the user who @@ -260874,6 +260885,7 @@ components: in: query schema: type: integer + format: int64 workflow-run-head-sha: name: head_sha description: Only returns workflow runs that are associated with the specified @@ -260929,6 +260941,7 @@ components: required: true schema: type: integer + format: int64 check-suite-id: name: check_suite_id description: The unique identifier of the check suite. 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..a791b3c0d1 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": { @@ -249199,7 +249200,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -249216,12 +249218,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -249594,7 +249598,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -249656,7 +249661,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -255584,7 +255590,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -255621,6 +255628,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -255636,6 +255644,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -258067,6 +258076,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -258082,6 +258092,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -261261,6 +261272,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -261276,6 +261288,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -263738,12 +263751,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -264943,12 +264958,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -268831,7 +268848,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -268868,6 +268886,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -268883,6 +268902,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -299461,7 +299481,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -300556,7 +300577,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -301917,7 +301939,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -302086,7 +302109,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -311221,7 +311245,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -312116,7 +312141,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -316055,7 +316081,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -316301,7 +316328,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -340503,7 +340531,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -618989,7 +619017,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 +820095,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -822119,6 +822148,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -824064,7 +824094,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 +826310,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -828262,7 +828293,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 +830284,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 +832336,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -940231,7 +940263,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 +942925,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..5cf18bc59a 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 @@ -59586,6 +59587,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -59600,10 +59602,12 @@ paths: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -61299,6 +61303,7 @@ paths: in: query schema: type: integer + format: int64 - &414 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -61329,6 +61334,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -61341,6 +61347,7 @@ paths: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -69611,6 +69618,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -76820,6 +76828,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -108884,9 +108894,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 +128534,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 +128858,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 +129183,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 +129531,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 +129796,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 +130077,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 +130394,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 +140999,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 +141111,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..55d318e6e4 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": { @@ -243163,7 +243164,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -243180,12 +243182,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -243558,7 +243562,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -243620,7 +243625,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -249514,7 +249520,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -249551,6 +249558,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -249566,6 +249574,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -251991,6 +252000,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -252006,6 +252016,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -255179,6 +255190,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -255194,6 +255206,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -257650,12 +257663,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -258855,12 +258870,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -262736,7 +262753,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -262773,6 +262791,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -262788,6 +262807,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -293341,7 +293361,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -294436,7 +294457,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -295797,7 +295819,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -295966,7 +295989,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -305089,7 +305113,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -305984,7 +306009,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -309757,7 +309783,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -310003,7 +310030,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -334025,7 +334053,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -607729,7 +607757,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 +804580,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -806592,6 +806621,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -808525,7 +808555,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 +810759,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -812699,7 +812730,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 +814709,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 +816749,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -923730,7 +923762,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 +926412,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..6211240bf3 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 @@ -59177,6 +59178,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -59191,10 +59193,12 @@ paths: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -60890,6 +60894,7 @@ paths: in: query schema: type: integer + format: int64 - &414 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -60920,6 +60925,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -60932,6 +60938,7 @@ paths: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -69179,6 +69186,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -76386,6 +76394,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -108342,9 +108352,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 +128100,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 +128424,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 +128749,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 +129097,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 +129362,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 +129643,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 +129960,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 +140565,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 +140677,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..97993ef7cb 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": { @@ -256438,7 +256439,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -256455,12 +256457,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -256833,7 +256837,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -256895,7 +256900,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -263029,7 +263035,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -263066,6 +263073,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -263081,6 +263089,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -265534,6 +265543,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -265549,6 +265559,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -268750,6 +268761,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -268765,6 +268777,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -271249,12 +271262,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -272454,12 +272469,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -276363,7 +276380,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -276400,6 +276418,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -276415,6 +276434,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -307042,7 +307062,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -308137,7 +308158,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -309498,7 +309520,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -309667,7 +309690,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -318846,7 +318870,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -319741,7 +319766,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -323969,7 +323995,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -324215,7 +324242,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -348775,7 +348803,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -634359,7 +634387,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 +842604,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -844653,6 +844682,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -846623,7 +846653,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 +848894,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -850871,7 +850902,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 +852918,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 +854995,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -964526,7 +964558,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 +967245,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..a0ec602b4f 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 @@ -60202,6 +60203,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -60216,10 +60218,12 @@ paths: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -61915,6 +61919,7 @@ paths: in: query schema: type: integer + format: int64 - &416 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -61945,6 +61950,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -61957,6 +61963,7 @@ paths: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -70252,6 +70259,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -77478,6 +77486,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -109739,9 +109749,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 +129502,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 +129826,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 +130151,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 +130499,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 +130764,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 +131045,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 +131362,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 +141967,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 +142079,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..b7fbbdf439 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": { @@ -75904,7 +75905,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -76413,7 +76414,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -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,14 +76738,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -77299,14 +77300,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -77530,7 +77531,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": { @@ -181099,6 +181101,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -181169,6 +181474,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -308176,7 +308802,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -308193,12 +308820,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -308571,7 +309200,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -308633,7 +309263,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -314657,7 +315288,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -314694,6 +315326,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -314709,6 +315342,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -317164,6 +317798,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -317179,6 +317814,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -320382,6 +321018,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -320397,6 +321034,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -322883,12 +323521,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -324088,12 +324728,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -327976,7 +328618,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -328013,6 +328656,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -328028,6 +328672,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -360733,7 +361378,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -361828,7 +362474,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -363189,7 +363836,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -363358,7 +364006,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -372541,7 +373190,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -373436,7 +374086,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -377375,7 +378026,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -377621,7 +378273,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -401871,7 +402524,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -694501,7 +695154,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 +906056,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -907455,6 +908109,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -909400,7 +910055,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 +912271,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -913598,7 +914254,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 +916245,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 +918297,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1056887,7 +1057544,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 +1060230,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..0b2cd09916 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 @@ -28483,9 +28484,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -28712,14 +28721,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -28836,13 +28845,21 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -29091,13 +29108,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -29136,14 +29159,14 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29250,7 +29273,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -52704,6 +52727,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 +52908,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 @@ -73966,6 +74296,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -73980,10 +74311,12 @@ paths: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -75752,6 +76085,7 @@ paths: in: query schema: type: integer + format: int64 - &553 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -75782,6 +76116,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -75794,6 +76129,7 @@ paths: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -84393,6 +84729,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -91602,6 +91939,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -126393,9 +126732,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 +146778,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 +147102,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 +147427,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 +147775,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 +148040,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 +148321,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 +148638,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 +160214,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 +160326,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..70a6e562a3 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": { @@ -75763,7 +75764,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -76272,7 +76273,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -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,14 +76597,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -77158,14 +77159,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -77389,7 +77390,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": { @@ -177424,6 +177426,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -177494,6 +177799,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -301893,7 +302519,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -301910,12 +302537,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -302288,7 +302917,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -302350,7 +302980,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -308340,7 +308971,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -308377,6 +309009,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -308392,6 +309025,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -310841,6 +311475,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -310856,6 +311491,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -314053,6 +314689,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -314068,6 +314705,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -316548,12 +317186,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -317753,12 +318393,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -321634,7 +322276,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -321671,6 +322314,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -321686,6 +322330,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -354366,7 +355011,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -355461,7 +356107,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -356822,7 +357469,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -356991,7 +357639,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -366162,7 +366811,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -367057,7 +367707,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -370830,7 +371481,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -371076,7 +371728,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -395146,7 +395799,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -682994,7 +683647,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 +890222,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -891609,6 +892263,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -893542,7 +894197,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 +896401,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -897716,7 +898372,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 +900351,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 +902391,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1039887,7 +1040544,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 +1043218,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..523e0a29f4 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 @@ -28413,9 +28414,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -28642,14 +28651,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -28766,13 +28775,21 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -29021,13 +29038,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -29066,14 +29089,14 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29180,7 +29203,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -52278,6 +52301,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 +52482,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 @@ -73546,6 +73876,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -73560,10 +73891,12 @@ paths: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -75332,6 +75665,7 @@ paths: in: query schema: type: integer + format: int64 - &553 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -75362,6 +75696,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -75374,6 +75709,7 @@ paths: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -83950,6 +84286,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -91157,6 +91494,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -125840,9 +126179,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 +146333,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 +146657,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 +146982,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 +147330,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 +147595,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 +147876,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 @@ -147854,6 +148193,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 @@ -159429,7 +159769,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 @@ -159540,7 +159881,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.deref.json b/descriptions/ghec/dereferenced/ghec.deref.json index f68cf351ba..0bb83fa4bd 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.json +++ b/descriptions/ghec/dereferenced/ghec.deref.json @@ -39534,7 +39534,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -76376,7 +76377,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -76885,7 +76886,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -76894,7 +76895,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" ], @@ -77209,14 +77210,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -77771,14 +77772,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -78002,7 +78003,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -78011,7 +78012,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" ], @@ -78270,7 +78271,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -161466,7 +161467,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -183514,6 +183516,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -183584,6 +183889,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -315663,7 +316289,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -315680,12 +316307,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -316058,7 +316687,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -316120,7 +316750,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -322350,7 +322981,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -322387,6 +323019,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -322402,6 +323035,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -324879,6 +325513,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -324894,6 +325529,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -328119,6 +328755,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -328134,6 +328771,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -330642,12 +331280,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -331847,12 +332487,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -335756,7 +336398,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -335793,6 +336436,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -335808,6 +336452,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -368562,7 +369207,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -369657,7 +370303,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -371018,7 +371665,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -371187,7 +371835,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -380414,7 +381063,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -381309,7 +381959,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -385537,7 +386188,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -385783,7 +386435,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -410391,7 +411044,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -710119,7 +710772,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" ], @@ -928285,6 +928938,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -930362,6 +931016,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -932332,7 +932987,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": { @@ -934573,6 +935228,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -936580,7 +937236,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 }, @@ -938596,7 +939252,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": { @@ -940673,6 +941329,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1081930,7 +1082587,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", @@ -1084641,7 +1085298,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.deref.yaml b/descriptions/ghec/dereferenced/ghec.deref.yaml index 36585f188d..6d2f2747d9 100644 --- a/descriptions/ghec/dereferenced/ghec.deref.yaml +++ b/descriptions/ghec/dereferenced/ghec.deref.yaml @@ -16313,6 +16313,7 @@ paths: - false positive - won't fix - used in tests + - mitigated dismissed_comment: &590 type: string description: The dismissal comment associated with the dismissal @@ -28656,9 +28657,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -28885,14 +28894,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -29009,13 +29018,21 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -29264,13 +29281,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -29309,14 +29332,14 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -29423,7 +29446,7 @@ paths: '503': *204 x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -53039,6 +53062,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 @@ -53070,6 +53243,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 @@ -74595,6 +74925,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -74609,10 +74940,12 @@ paths: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -76381,6 +76714,7 @@ paths: in: query schema: type: integer + format: int64 - &555 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -76411,6 +76745,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -76423,6 +76758,7 @@ paths: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -85047,6 +85383,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -92273,6 +92610,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -127261,9 +127600,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 @@ -147423,6 +147759,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 @@ -147746,6 +148083,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 @@ -148070,8 +148408,8 @@ x-webhooks: dismissed_comment: *590 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 @@ -148418,6 +148756,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 @@ -148682,8 +149021,8 @@ x-webhooks: dismissed_comment: *590 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: @@ -148963,8 +149302,8 @@ x-webhooks: dismissed_comment: *590 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 @@ -149280,6 +149619,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 @@ -160855,7 +161195,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 @@ -160966,7 +161307,8 @@ x-webhooks: repositories_added: *970 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/ghec.2022-11-28.json b/descriptions/ghec/ghec.2022-11-28.json index 5342fcf45d..23932c1fa1 100644 --- a/descriptions/ghec/ghec.2022-11-28.json +++ b/descriptions/ghec/ghec.2022-11-28.json @@ -18564,7 +18564,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -18758,7 +18758,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -18767,7 +18767,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" ], @@ -18806,14 +18806,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -19030,14 +19030,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -19076,7 +19076,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19085,7 +19085,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" ], @@ -19173,7 +19173,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39472,6 +39472,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39513,6 +39696,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -69288,7 +69660,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -96491,7 +96863,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" ], @@ -142835,7 +143207,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "code-scanning-alert-dismissed-comment": { @@ -164199,12 +164572,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -164653,6 +165028,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -164668,6 +165044,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -199501,6 +199878,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -199835,6 +200213,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -200183,7 +200562,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": { @@ -200560,6 +200939,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -200824,7 +201204,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 }, @@ -201099,7 +201479,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": { @@ -201433,6 +201813,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -211232,7 +211613,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", @@ -211304,7 +211685,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", @@ -369039,7 +369420,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -369119,7 +369501,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "workflow-run-head-sha": { @@ -369190,7 +369573,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { diff --git a/descriptions/ghec/ghec.2022-11-28.yaml b/descriptions/ghec/ghec.2022-11-28.yaml index 0d65b9dd9e..ac1ffeced6 100644 --- a/descriptions/ghec/ghec.2022-11-28.yaml +++ b/descriptions/ghec/ghec.2022-11-28.yaml @@ -13755,9 +13755,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -13908,14 +13916,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -13940,13 +13948,21 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -14108,13 +14124,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -14139,14 +14161,14 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -14204,7 +14226,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -29220,6 +29242,161 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -29252,6 +29429,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -50905,6 +51244,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -70480,9 +70821,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 @@ -104199,6 +104537,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. @@ -120977,10 +121316,12 @@ components: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -121351,6 +121692,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -121363,6 +121705,7 @@ components: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -147779,6 +148122,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: @@ -148039,6 +148383,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: @@ -148307,7 +148652,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: @@ -148600,6 +148945,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: @@ -148809,7 +149155,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: @@ -149032,7 +149378,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: @@ -149293,6 +149639,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: @@ -156325,7 +156672,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 @@ -156377,7 +156725,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 @@ -279483,6 +279832,7 @@ components: required: true schema: type: integer + format: int64 actor: name: actor description: Returns someone's workflow runs. Use the login for the user who @@ -279556,6 +279906,7 @@ components: in: query schema: type: integer + format: int64 workflow-run-head-sha: name: head_sha description: Only returns workflow runs that are associated with the specified @@ -279611,6 +279962,7 @@ components: required: true schema: type: integer + format: int64 check-suite-id: name: check_suite_id description: The unique identifier of the check suite. diff --git a/descriptions/ghec/ghec.2026-03-10.json b/descriptions/ghec/ghec.2026-03-10.json index d9e8c07977..139e13ae8e 100644 --- a/descriptions/ghec/ghec.2026-03-10.json +++ b/descriptions/ghec/ghec.2026-03-10.json @@ -18564,7 +18564,7 @@ }, "post": { "summary": "Create a budget", - "description": "Creates a new budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Creates a new budget for an enterprise. Enterprise owners and billing managers can create budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can create budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can create budgets for any target in the enterprise.", "tags": [ "billing" ], @@ -18758,7 +18758,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -18767,7 +18767,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" ], @@ -18806,14 +18806,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "patch": { "summary": "Update a budget", - "description": "Updates an existing budget for an enterprise. The authenticated user must be an enterprise admin, organization admin, or billing manager of the enterprise.", + "description": "Updates an existing budget for an enterprise. Enterprise owners and billing managers can update budgets scoped to the enterprise, all users in the enterprise, or any organization in it; organization administrators can update budgets for their organizations, and repository-scoped budgets require administration of the repository's owning organization. For authorization, fine-grained write access to enterprise billing is sufficient without an additional administrator role for budgets scoped to a single user or a cost center, including all users in a cost center; for the other scopes, the role requirements above still apply. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can update any budget in the enterprise.", "tags": [ "billing" ], @@ -19030,14 +19030,14 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise, organization administrators can delete budgets scoped to the organizations they administer, and repository administrators can delete budgets scoped to repositories they administer in those organizations. Fine-grained write access to enterprise billing does not by itself allow you to delete a budget for a target you do not administer. An installation access token for a GitHub App installed on the enterprise with write access to enterprise billing can delete any budget in the enterprise.", "tags": [ "billing" ], @@ -19076,7 +19076,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -19085,7 +19085,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" ], @@ -19173,7 +19173,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "category": "billing", "subcategory": "budgets" } @@ -39414,6 +39414,189 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -39455,6 +39638,195 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "$ref": "#/components/parameters/org" + }, + { + "$ref": "#/components/parameters/username" + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "$ref": "#/components/responses/forbidden" + }, + "404": { + "$ref": "#/components/responses/not_found" + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/basic-error" + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -69197,7 +69569,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -96390,7 +96762,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" ], @@ -142651,7 +143023,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "code-scanning-alert-dismissed-comment": { @@ -163612,12 +163985,14 @@ "id": { "description": "The id of the job.", "example": 21, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_id": { "description": "The id of the associated workflow run.", "example": 5, - "type": "integer" + "type": "integer", + "format": "int64" }, "run_url": { "type": "string", @@ -164066,6 +164441,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -164081,6 +164457,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -199057,6 +199434,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -199391,6 +199769,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -199739,7 +200118,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": { @@ -200116,6 +200495,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -200380,7 +200760,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 }, @@ -200655,7 +201035,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": { @@ -200989,6 +201369,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -210788,7 +211169,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", @@ -210860,7 +211241,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", @@ -368161,7 +368542,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -368241,7 +368623,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "workflow-run-head-sha": { @@ -368312,7 +368695,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { diff --git a/descriptions/ghec/ghec.2026-03-10.yaml b/descriptions/ghec/ghec.2026-03-10.yaml index e38c80568d..eaf5144093 100644 --- a/descriptions/ghec/ghec.2026-03-10.yaml +++ b/descriptions/ghec/ghec.2026-03-10.yaml @@ -13755,9 +13755,17 @@ paths: subcategory: budgets post: summary: Create a budget - description: Creates a new budget for an enterprise. The authenticated user - must be an enterprise admin, organization admin, or billing manager of the - enterprise. + description: Creates a new budget for an enterprise. Enterprise owners and billing + managers can create budgets scoped to the enterprise, all users in the enterprise, + or any organization in it; organization administrators can create budgets + for their organizations, and repository-scoped budgets require administration + of the repository's owning organization. For authorization, fine-grained write + access to enterprise billing is sufficient without an additional administrator + role for budgets scoped to a single user or a cost center, including all users + in a cost center; for the other scopes, the role requirements above still + apply. An installation access token for a GitHub App installed on the enterprise + with write access to enterprise billing can create budgets for any target + in the enterprise. tags: - billing operationId: billing/create-budget @@ -13908,14 +13916,14 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#create-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. The authenticated actor must have permission + to view enterprise billing. tags: - billing operationId: billing/get-budget @@ -13940,13 +13948,21 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets patch: summary: Update a budget - description: Updates an existing budget for an enterprise. The authenticated - user must be an enterprise admin, organization admin, or billing manager of + description: Updates an existing budget for an enterprise. Enterprise owners + and billing managers can update budgets scoped to the enterprise, all users + in the enterprise, or any organization in it; organization administrators + can update budgets for their organizations, and repository-scoped budgets + require administration of the repository's owning organization. For authorization, + fine-grained write access to enterprise billing is sufficient without an additional + administrator role for budgets scoped to a single user or a cost center, including + all users in a cost center; for the other scopes, the role requirements above + still apply. An installation access token for a GitHub App installed on the + enterprise with write access to enterprise billing can update any budget in the enterprise. tags: - billing @@ -14108,13 +14124,19 @@ paths: documentation_url: https://docs.github.com/rest/billing/budgets#update-a-budget x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise, organization administrators can delete + budgets scoped to the organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer in those organizations. + Fine-grained write access to enterprise billing does not by itself allow you + to delete a budget for a target you do not administer. An installation access + token for a GitHub App installed on the enterprise with write access to enterprise + billing can delete any budget in the enterprise. tags: - billing operationId: billing/delete-budget @@ -14139,14 +14161,14 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + The authenticated actor must have permission to view enterprise billing. tags: - billing operationId: billing/get-budget-user-states @@ -14204,7 +14226,7 @@ paths: "$ref": "#/components/responses/service_unavailable" x-github: githubCloudOnly: true - enabledForGitHubApps: false + enabledForGitHubApps: true category: billing subcategory: budgets "/enterprises/{enterprise}/settings/billing/cost-centers": @@ -29175,6 +29197,161 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - "$ref": "#/components/parameters/org" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -29207,6 +29384,168 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - "$ref": "#/components/parameters/org" + - "$ref": "#/components/parameters/username" + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': + "$ref": "#/components/responses/forbidden" + '404': + "$ref": "#/components/responses/not_found" + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: + "$ref": "#/components/schemas/basic-error" + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -50833,6 +51172,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -70396,9 +70737,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 @@ -104046,6 +104384,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. @@ -120513,10 +120852,12 @@ components: description: The id of the job. example: 21 type: integer + format: int64 run_id: description: The id of the associated workflow run. example: 5 type: integer + format: int64 run_url: type: string example: https://api.github.com/repos/github/hello-world/actions/runs/5 @@ -120887,6 +121228,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -120899,6 +121241,7 @@ components: example: MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. example: 42 check_suite_node_id: @@ -147421,6 +147764,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: @@ -147681,6 +148025,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: @@ -147949,7 +148294,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: @@ -148242,6 +148587,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: @@ -148451,7 +148797,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: @@ -148674,7 +149020,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: @@ -148935,6 +149281,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: @@ -155967,7 +156314,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 @@ -156019,7 +156367,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" {"code":"deadline_exceeded","msg":"operation timed out"}