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..2b4db113a8 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": { @@ -134053,6 +134054,10 @@ "projects-v2-field-iteration-configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -134069,6 +134074,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -140399,12 +140409,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 +140864,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -140867,6 +140880,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -174532,6 +174546,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174866,6 +174881,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175214,7 +175230,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 +175607,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175855,7 +175872,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 +176147,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 +176481,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -186263,7 +186281,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 +186353,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", @@ -316370,22 +316388,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -341399,7 +341411,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -341479,7 +341492,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 +341564,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..806c466f28 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. @@ -98636,6 +98636,9 @@ components: projects-v2-field-iteration-configuration: type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -98651,6 +98654,10 @@ components: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -103607,10 +103614,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 +103989,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -103992,6 +104002,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 +129579,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 +129840,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 +130109,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 +130402,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 +130612,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 +130835,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 +131096,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 +138129,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 +138182,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 @@ -237685,17 +237702,13 @@ components: name: Sprint data_type: iteration iteration_configuration: - start_day: 1 + start_date: '2022-07-01' duration: 14 iterations: - - title: - raw: Sprint 1 - html: Sprint 1 + - title: Sprint 1 start_date: '2022-07-01' duration: 14 - - title: - raw: Sprint 2 - html: Sprint 2 + - title: Sprint 2 start_date: '2022-07-15' duration: 14 projects-v2-field-text: @@ -259296,6 +259309,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 +259383,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 +259439,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..543ecd92b2 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": { @@ -133544,6 +133545,10 @@ "projects-v2-field-iteration-configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -133560,6 +133565,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -139830,12 +139840,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 +140295,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -140298,6 +140311,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -174106,6 +174120,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174440,6 +174455,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -174788,7 +174804,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 +175181,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -175429,7 +175446,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 +175721,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 +176055,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -185837,7 +185855,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 +185927,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", @@ -315609,22 +315627,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -340539,7 +340551,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -340619,7 +340632,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 +340704,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..10eba3178d 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. @@ -98234,6 +98234,9 @@ components: projects-v2-field-iteration-configuration: type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -98249,6 +98252,10 @@ components: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -103155,10 +103162,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 +103537,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -103540,6 +103550,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 +129233,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 +129494,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 +129763,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 +130056,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 +130266,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 +130489,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 +130750,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 +137783,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 +137836,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 @@ -236996,17 +237013,13 @@ components: name: Sprint data_type: iteration iteration_configuration: - start_day: 1 + start_date: '2022-07-01' duration: 14 iterations: - - title: - raw: Sprint 1 - html: Sprint 1 + - title: Sprint 1 start_date: '2022-07-01' duration: 14 - - title: - raw: Sprint 2 - html: Sprint 2 + - title: Sprint 2 start_date: '2022-07-15' duration: 14 projects-v2-field-text: @@ -258514,6 +258527,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 +258601,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 +258657,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..976cede1e1 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": { @@ -134918,6 +134919,10 @@ "projects-v2-field-iteration-configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -134934,6 +134939,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -141524,12 +141534,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 +141989,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -141992,6 +142005,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -176003,6 +176017,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -176337,6 +176352,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -176685,7 +176701,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 +177078,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -177326,7 +177343,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 +177618,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 +177952,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -187734,7 +187752,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 +187824,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", @@ -318535,22 +318553,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -343740,7 +343752,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -343820,7 +343833,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 +343905,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..685ccccfbd 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. @@ -99216,6 +99216,9 @@ components: projects-v2-field-iteration-configuration: type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -99231,6 +99234,10 @@ components: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -104406,10 +104413,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 +104788,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -104791,6 +104801,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 +130648,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 +130909,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 +131178,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 +131471,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 +131681,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 +131904,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 +132165,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 +139198,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 +139251,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 @@ -239102,17 +239119,13 @@ components: name: Sprint data_type: iteration iteration_configuration: - start_day: 1 + start_date: '2022-07-01' duration: 14 iterations: - - title: - raw: Sprint 1 - html: Sprint 1 + - title: Sprint 1 start_date: '2022-07-01' duration: 14 - - title: - raw: Sprint 2 - html: Sprint 2 + - title: Sprint 2 start_date: '2022-07-15' duration: 14 projects-v2-field-text: @@ -260801,6 +260814,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 +260888,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 +260944,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..45e61dc5c2 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": { @@ -189789,6 +189790,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -189805,6 +189810,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -189904,22 +189914,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -249199,7 +249203,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -249216,12 +249221,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 +249601,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -249656,7 +249664,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -255584,7 +255593,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -255621,6 +255631,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -255636,6 +255647,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -258067,6 +258079,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -258082,6 +258095,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -261261,6 +261275,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -261276,6 +261291,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -263738,12 +263754,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 +264961,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 +268851,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -268868,6 +268889,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -268883,6 +268905,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -299461,7 +299484,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -300556,7 +300580,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -301917,7 +301942,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -302086,7 +302112,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -311221,7 +311248,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -312116,7 +312144,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -316055,7 +316084,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -316301,7 +316331,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -340503,7 +340534,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 +619020,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" ], @@ -745038,6 +745069,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -745054,6 +745089,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -745153,22 +745193,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -820067,6 +820101,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -822119,6 +822154,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -824064,7 +824100,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 +826316,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -828262,7 +828299,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 +830290,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 +832342,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -940231,7 +940269,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 +942931,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..edf5df3954 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 @@ -47074,6 +47075,9 @@ paths: iteration_configuration: &782 type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -47089,6 +47093,10 @@ paths: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -47154,17 +47162,13 @@ paths: name: Sprint data_type: iteration iteration_configuration: - start_day: 1 + start_date: '2022-07-01' duration: 14 iterations: - - title: - raw: Sprint 1 - html: Sprint 1 + - title: Sprint 1 start_date: '2022-07-01' duration: 14 - - title: - raw: Sprint 2 - html: Sprint 2 + - title: Sprint 2 start_date: '2022-07-15' duration: 14 responses: @@ -59586,6 +59590,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -59600,10 +59605,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 +61306,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 +61337,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -61341,6 +61350,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 +69621,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -76820,6 +76831,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 +108897,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 +128537,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 +128861,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 +129186,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 +129534,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 +129799,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 +130080,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 +130397,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 +141002,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 +141114,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..a2f72957e8 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": { @@ -184254,6 +184255,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -184270,6 +184275,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -184369,22 +184379,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -243163,7 +243167,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -243180,12 +243185,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 +243565,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -243620,7 +243628,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -249514,7 +249523,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -249551,6 +249561,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -249566,6 +249577,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -251991,6 +252003,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -252006,6 +252019,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -255179,6 +255193,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -255194,6 +255209,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -257650,12 +257666,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 +258873,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 +262756,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -262773,6 +262794,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "example": 5 }, @@ -262788,6 +262810,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "example": 42 }, @@ -293341,7 +293364,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -294436,7 +294460,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -295797,7 +295822,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -295966,7 +295992,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -305089,7 +305116,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -305984,7 +306012,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -309757,7 +309786,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -310003,7 +310033,8 @@ "enum": [ "false positive", "won't fix", - "used in tests" + "used in tests", + "mitigated" ] }, "dismissed_comment": { @@ -334025,7 +334056,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 +607760,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" ], @@ -730600,6 +730631,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -730616,6 +730651,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -730715,22 +730755,16 @@ "name": "Sprint", "data_type": "iteration", "iteration_configuration": { - "start_day": 1, + "start_date": "2022-07-01", "duration": 14, "iterations": [ { - "title": { - "raw": "Sprint 1", - "html": "Sprint 1" - }, + "title": "Sprint 1", "start_date": "2022-07-01", "duration": 14 }, { - "title": { - "raw": "Sprint 2", - "html": "Sprint 2" - }, + "title": "Sprint 2", "start_date": "2022-07-15", "duration": 14 } @@ -804552,6 +804586,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -806592,6 +806627,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -808525,7 +808561,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 +810765,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -812699,7 +812736,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 +814715,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 +816755,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -923730,7 +923768,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 +926418,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..d2059f99c3 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 @@ -46713,6 +46714,9 @@ paths: iteration_configuration: &782 type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -46728,6 +46732,10 @@ paths: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -46793,17 +46801,13 @@ paths: name: Sprint data_type: iteration iteration_configuration: - start_day: 1 + start_date: '2022-07-01' duration: 14 iterations: - - title: - raw: Sprint 1 - html: Sprint 1 + - title: Sprint 1 start_date: '2022-07-01' duration: 14 - - title: - raw: Sprint 2 - html: Sprint 2 + - title: Sprint 2 start_date: '2022-07-15' duration: 14 responses: @@ -59177,6 +59181,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -59191,10 +59196,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 +60897,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 +60928,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. example: 5 name: @@ -60932,6 +60941,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 +69189,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -76386,6 +76397,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 +108355,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 +128103,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 +128427,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 +128752,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 +129100,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 +129365,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 +129646,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 +129963,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 +140568,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 +140680,8 @@ x-webhooks: repositories_added: *823 repositories_removed: description: An array of repository objects, which were removed - from the installation. {"code":"deadline_exceeded","msg":"operation timed out"}