diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.json b/descriptions-next/api.github.com/api.github.com.2022-11-28.json index 7de9ec9309..778b1e0a26 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.json +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.json @@ -54766,7 +54766,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -79427,7 +79427,7 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -131058,6 +131058,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -135774,6 +135775,10 @@ "projects-v2-field-iteration-configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -135790,6 +135795,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -142503,6 +142513,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -142510,6 +142521,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -143062,6 +143074,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -143085,6 +143098,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -178925,6 +178939,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179276,6 +179291,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179650,7 +179666,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -180062,6 +180078,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180349,7 +180366,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -180657,7 +180674,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -181012,6 +181029,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -191081,7 +191099,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -191153,7 +191171,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", @@ -326239,22 +326257,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 } @@ -351280,7 +351292,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -351360,7 +351373,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": { @@ -351431,7 +351445,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { diff --git a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml index 93de2388ed..f5fabdc699 100644 --- a/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml +++ b/descriptions-next/api.github.com/api.github.com.2022-11-28.yaml @@ -40357,6 +40357,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -58098,9 +58100,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -95482,6 +95481,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -99039,6 +99039,9 @@ components: projects-v2-field-iteration-configuration: type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -99054,6 +99057,10 @@ components: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -103984,11 +103991,13 @@ components: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -104411,6 +104420,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -104427,6 +104437,7 @@ components: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -130358,6 +130369,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130627,6 +130639,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130908,7 +130921,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131219,6 +131232,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131440,7 +131454,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -131680,7 +131694,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131952,6 +131966,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -139120,7 +139135,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -139172,7 +139188,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 @@ -241256,17 +241273,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: @@ -262873,6 +262886,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 @@ -262946,6 +262960,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 @@ -263001,6 +263016,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-next/api.github.com/api.github.com.2026-03-10.json b/descriptions-next/api.github.com/api.github.com.2026-03-10.json index 4c96fcc711..d218e40732 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.json +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.json @@ -54691,7 +54691,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -79338,7 +79338,7 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -130494,6 +130494,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -135189,6 +135190,10 @@ "projects-v2-field-iteration-configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -135205,6 +135210,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -141863,6 +141873,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -141870,6 +141881,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -142422,6 +142434,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -142445,6 +142458,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -178452,6 +178466,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -178803,6 +178818,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179177,7 +179193,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -179589,6 +179605,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -179876,7 +179893,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -180184,7 +180201,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -180539,6 +180556,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -190608,7 +190626,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -190680,7 +190698,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", @@ -325381,22 +325399,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 } @@ -350323,7 +350335,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -350403,7 +350416,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": { @@ -350474,7 +350488,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { diff --git a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml index 7002d32aed..5c7e8ea5d9 100644 --- a/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml +++ b/descriptions-next/api.github.com/api.github.com.2026-03-10.yaml @@ -40296,6 +40296,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -58023,9 +58025,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -95063,6 +95062,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -98608,6 +98608,9 @@ components: projects-v2-field-iteration-configuration: type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -98623,6 +98626,10 @@ components: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -103513,11 +103520,13 @@ components: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -103940,6 +103949,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -103956,6 +103966,7 @@ components: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -130014,6 +130025,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130283,6 +130295,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -130564,7 +130577,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -130875,6 +130888,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131096,7 +131110,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -131336,7 +131350,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -131608,6 +131622,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -138776,7 +138791,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -138828,7 +138844,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 @@ -240544,17 +240561,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: @@ -262068,6 +262081,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 @@ -262141,6 +262155,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 @@ -262196,6 +262211,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-next/api.github.com/api.github.com.json b/descriptions-next/api.github.com/api.github.com.json index 98beafd16f..31369eaa26 100644 --- a/descriptions-next/api.github.com/api.github.com.json +++ b/descriptions-next/api.github.com/api.github.com.json @@ -55026,7 +55026,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -79734,7 +79734,7 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -131810,6 +131810,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -136628,6 +136629,10 @@ "projects-v2-field-iteration-configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -136644,6 +136649,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -143514,6 +143524,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -143521,6 +143532,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -144073,6 +144085,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -144096,6 +144109,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -180197,6 +180211,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180548,6 +180563,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -180922,7 +180938,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -181334,6 +181350,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -181621,7 +181638,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -181929,7 +181946,7 @@ "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -182284,6 +182301,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -192353,7 +192371,7 @@ "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -192425,7 +192443,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", @@ -328205,22 +328223,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 } @@ -353422,7 +353434,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "actor": { @@ -353502,7 +353515,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": { @@ -353573,7 +353587,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, "check-suite-id": { diff --git a/descriptions-next/api.github.com/api.github.com.yaml b/descriptions-next/api.github.com/api.github.com.yaml index 02f41ccb4e..b5577a6428 100644 --- a/descriptions-next/api.github.com/api.github.com.yaml +++ b/descriptions-next/api.github.com/api.github.com.yaml @@ -40495,6 +40495,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -58286,9 +58288,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -95972,6 +95971,7 @@ components: - false positive - won't fix - used in tests + - mitigated - code-scanning-alert-dismissed-comment: type: @@ -99613,6 +99613,9 @@ components: projects-v2-field-iteration-configuration: type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -99628,6 +99631,10 @@ components: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -104688,11 +104695,13 @@ components: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -105115,6 +105124,7 @@ components: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -105131,6 +105141,7 @@ components: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -131275,6 +131286,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131544,6 +131556,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -131825,7 +131838,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -132136,6 +132149,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -132357,7 +132371,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - string - 'null' @@ -132597,7 +132611,7 @@ components: "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" dismissed_reason: description: 'The reason for dismissing or closing the alert. Can be - one of: `false positive`, `won''t fix`, and `used in tests`.' + one of: `false positive`, `won''t fix`, `used in tests`, and `mitigated`.' type: - 'null' fixed_at: @@ -132869,6 +132883,7 @@ components: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 format: @@ -140037,7 +140052,8 @@ components: "$ref": "#/components/schemas/webhooks_repositories_added" repositories_removed: description: An array of repository objects, which were removed from the - installation. + installation. When `repository_selection` changes from `all` to `selected`, + this array is empty. type: array items: type: object @@ -140089,7 +140105,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 @@ -242521,17 +242538,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: @@ -264226,6 +264239,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 @@ -264299,6 +264313,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 @@ -264354,6 +264369,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-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json index b3a97bb718..d6e871d74b 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.json @@ -123156,6 +123156,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -219223,6 +219224,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -219239,6 +219244,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -219338,22 +219348,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 } @@ -287153,7 +287157,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -287170,6 +287175,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -287177,6 +287183,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -287627,7 +287634,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -287689,7 +287697,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -294173,7 +294182,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -294210,6 +294220,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -294233,6 +294244,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -297186,6 +297198,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -297209,6 +297222,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -301006,6 +301020,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -301029,6 +301044,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -304013,6 +304029,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -304020,6 +304037,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -305315,6 +305333,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -305322,6 +305341,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -309661,7 +309681,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -309698,6 +309719,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -309721,6 +309743,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -345690,7 +345713,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -347056,7 +347080,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -348688,7 +348713,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -348887,7 +348913,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -359542,6 +359569,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -360617,6 +360645,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -365663,6 +365692,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -365971,6 +366001,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -394253,7 +394284,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -733034,7 +733065,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" ], @@ -885110,6 +885141,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -885126,6 +885161,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -885225,22 +885265,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 } @@ -975512,6 +975546,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -977997,6 +978032,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -980340,7 +980376,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -983051,6 +983087,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -985472,7 +985509,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -987912,7 +987949,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -990401,6 +990438,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1119267,7 +1119305,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1122446,7 +1122484,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml index 753f17532c..b0a66a9adf 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2022-11-28.deref.yaml @@ -32834,6 +32834,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -48190,6 +48191,9 @@ paths: iteration_configuration: &752 type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -48205,6 +48209,10 @@ paths: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -48270,17 +48278,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: @@ -61131,6 +61135,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -61144,11 +61149,13 @@ paths: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -62890,6 +62897,7 @@ paths: in: query schema: type: integer + format: int64 - &397 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -62920,6 +62928,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -62936,6 +62945,7 @@ paths: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -71407,6 +71417,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -78713,6 +78724,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -111022,9 +111035,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -131031,6 +131041,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131363,6 +131374,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131700,8 +131712,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132066,6 +132078,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132342,8 +132355,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -132640,8 +132653,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132968,6 +132981,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -143718,7 +143732,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -143829,7 +143844,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json index 75e4733dcf..3f91554ae8 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.json @@ -118844,6 +118844,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -212251,6 +212252,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -212267,6 +212272,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -212366,22 +212376,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 } @@ -279543,7 +279547,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -279560,6 +279565,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -279567,6 +279573,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -280017,7 +280024,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -280079,7 +280087,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -286525,7 +286534,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -286562,6 +286572,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -286585,6 +286596,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -289532,6 +289544,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -289555,6 +289568,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -293346,6 +293360,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -293369,6 +293384,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -296347,6 +296363,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -296354,6 +296371,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -297649,6 +297667,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -297656,6 +297675,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -301988,7 +302008,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -302025,6 +302046,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -302048,6 +302070,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -337992,7 +338015,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -339358,7 +339382,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -340990,7 +341015,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -341189,7 +341215,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -351832,6 +351859,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -352907,6 +352935,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -357729,6 +357758,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -358037,6 +358067,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -386081,7 +386112,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -718664,7 +718695,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" ], @@ -866688,6 +866719,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -866704,6 +866739,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -866803,22 +866843,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 } @@ -955716,6 +955750,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -958189,6 +958224,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -960520,7 +960556,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -963219,6 +963255,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -965628,7 +965665,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -968056,7 +968093,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -970533,6 +970570,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1098411,7 +1098449,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1101578,7 +1101616,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml index 0a127ff5b6..9649f739ec 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.2026-03-10.deref.yaml @@ -32478,6 +32478,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -47820,6 +47821,9 @@ paths: iteration_configuration: &752 type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -47835,6 +47839,10 @@ paths: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -47900,17 +47908,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: @@ -60707,6 +60711,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -60720,11 +60725,13 @@ paths: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -62466,6 +62473,7 @@ paths: in: query schema: type: integer + format: int64 - &397 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -62496,6 +62504,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -62512,6 +62521,7 @@ paths: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -70960,6 +70970,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -78264,6 +78275,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -110464,9 +110477,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -130599,6 +130609,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -130931,6 +130942,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131268,8 +131280,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -131634,6 +131646,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -131910,8 +131923,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -132208,8 +132221,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -132536,6 +132549,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -143286,7 +143300,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -143397,7 +143412,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json index aa96f0c99c..bedbd93fbc 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.json @@ -125296,6 +125296,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -225240,6 +225241,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -225256,6 +225261,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -225355,22 +225365,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 } @@ -294944,7 +294948,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -294961,6 +294966,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -294968,6 +294974,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -295418,7 +295425,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -295480,7 +295488,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -302170,7 +302179,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -302207,6 +302217,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -302230,6 +302241,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -305205,6 +305217,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -305228,6 +305241,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -309047,6 +309061,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -309070,6 +309085,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -312076,6 +312092,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -312083,6 +312100,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -313378,6 +313396,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -313385,6 +313404,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -317745,7 +317765,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -317782,6 +317803,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -317805,6 +317827,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -353823,7 +353846,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -355189,7 +355213,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -356821,7 +356846,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -357020,7 +357046,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -367719,6 +367746,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -368794,6 +368822,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -374129,6 +374158,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -374437,6 +374467,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -403077,7 +403108,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -748956,7 +748987,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" ], @@ -907035,6 +907066,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -907051,6 +907086,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -907150,22 +907190,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 } @@ -999113,6 +999147,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1001623,6 +1001658,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1003991,7 +1004027,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1006727,6 +1006763,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1009173,7 +1009210,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1011638,7 +1011675,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1014152,6 +1014189,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1144654,7 +1144692,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1147858,7 +1147896,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml index 9932ba2762..a40d4fad27 100644 --- a/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml +++ b/descriptions-next/api.github.com/dereferenced/api.github.com.deref.yaml @@ -33156,6 +33156,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &434 type: @@ -48633,6 +48634,9 @@ paths: iteration_configuration: &752 type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -48648,6 +48652,10 @@ paths: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -48713,17 +48721,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: @@ -61745,6 +61749,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -61758,11 +61763,13 @@ paths: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -63504,6 +63511,7 @@ paths: in: query schema: type: integer + format: int64 - &397 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -63534,6 +63542,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -63550,6 +63559,7 @@ paths: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -72046,6 +72056,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -79369,6 +79380,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -111874,9 +111887,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -131996,6 +132006,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132328,6 +132339,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -132665,8 +132677,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -133031,6 +133043,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -133307,8 +133320,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -133605,8 +133618,8 @@ webhooks: dismissed_comment: *434 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -133933,6 +133946,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -144683,7 +144697,8 @@ webhooks: - private repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object @@ -144794,7 +144809,8 @@ webhooks: repositories_added: *791 repositories_removed: description: An array of repository objects, which were removed - from the installation. + from the installation. When `repository_selection` changes from + `all` to `selected`, this array is empty. type: array items: type: object diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json index b319fb2728..95f877f883 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.json @@ -42602,6 +42602,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -81640,7 +81641,7 @@ "/enterprises/{enterprise}/settings/billing/budgets": { "get": { "summary": "Get all budgets", - "description": "Gets all budgets for an enterprise. The authenticated actor must have permission to view enterprise billing.\nEach page returns up to 100 budgets.", + "description": "Gets budgets for an enterprise. Enterprise owners and billing managers can view all budgets. Organization administrators can view budgets scoped to organizations and repositories they administer.\nEach page returns up to 100 budgets.", "tags": [ "billing" ], @@ -82034,7 +82035,7 @@ }, "x-github": { "githubCloudOnly": true, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "category": "billing", "subcategory": "budgets" } @@ -82587,7 +82588,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": { "get": { "summary": "Get a budget by ID", - "description": "Gets a budget by ID. The authenticated user must be an enterprise admin or billing manager.", + "description": "Gets a budget by ID. Enterprise owners and billing managers can view any budget in the enterprise. Organization administrators can view budgets scoped to organizations and repositories they administer.", "tags": [ "billing" ], @@ -83525,7 +83526,7 @@ }, "delete": { "summary": "Delete a budget", - "description": "Deletes a budget by ID. The authenticated user must be an enterprise admin.", + "description": "Deletes a budget by ID. Enterprise owners and billing managers can delete any budget in the enterprise. Organization administrators can delete budgets scoped to organizations they administer, and repository administrators can delete budgets scoped to repositories they administer.", "tags": [ "billing" ], @@ -83766,7 +83767,7 @@ "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}/user-states": { "get": { "summary": "Get user states for a multi-user budget", - "description": "Lists per-user budget state for a multi-user customer scoped budget. The authenticated user must be an enterprise admin or billing manager.", + "description": "Lists per-user budget state for a multi-user customer scoped budget. Enterprise owners and billing managers can view state across the enterprise. Organization administrators can view state for budgets scoped to organizations they administer.", "tags": [ "billing" ], @@ -84034,7 +84035,7 @@ "/enterprises/{enterprise}/settings/billing/cost-centers": { "get": { "summary": "Get all cost centers for an enterprise", - "description": "Gets a list of all the cost centers for an enterprise.", + "description": "Gets a list of all the cost centers for an enterprise. Enterprise owners and billing managers can view all cost centers. Organization owners can view cost centers associated with resources they administer.", "tags": [ "billing" ], @@ -84360,7 +84361,7 @@ }, "post": { "summary": "Create a new cost center", - "description": "Creates a new cost center for an enterprise. The authenticated user must be an enterprise admin.", + "description": "Creates a new cost center for an enterprise. The authenticated user must be an enterprise owner or billing manager.", "tags": [ "billing" ], @@ -84636,7 +84637,7 @@ "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}": { "get": { "summary": "Get a cost center by ID", - "description": "Gets a cost center by ID. The authenticated user must be an enterprise admin.", + "description": "Gets a cost center by ID. Enterprise owners and billing managers can view any cost center. Organization owners can view cost centers associated with resources they administer.", "tags": [ "billing" ], @@ -84948,7 +84949,7 @@ }, "patch": { "summary": "Update a cost center", - "description": "Updates an existing cost center.", + "description": "Updates an existing cost center. Enterprise owners and billing managers can update any cost center. Organization owners can update cost centers associated with resources they administer.", "tags": [ "billing" ], @@ -85435,7 +85436,7 @@ }, "delete": { "summary": "Delete a cost center", - "description": "Archieves a cost center by ID. The authenticated user must be an enterprise admin.", + "description": "Archives a cost center by ID. Enterprise owners and billing managers can archive any cost center. Organization owners can archive cost centers associated with resources they administer.", "tags": [ "billing" ], @@ -85691,7 +85692,7 @@ "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}/resource": { "post": { "summary": "Add resources to a cost center", - "description": "Adds resources to a cost center.\n\nThe usage for the resources will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.", + "description": "Adds resources to a cost center.\n\nThe usage for the resources will be charged to the cost center's budget. Enterprise owners and billing managers can add any resource. Organization owners can add non-team resources to cost centers associated with resources they administer.", "tags": [ "billing" ], @@ -86015,7 +86016,7 @@ }, "delete": { "summary": "Remove resources from a cost center", - "description": "Remove resources from a cost center.\n\nThe usage for the resources will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint.", + "description": "Remove resources from a cost center.\n\nThe usage for the resources will no longer be charged to the cost center's budget. Enterprise owners and billing managers can remove any resource. Organization owners can remove non-team resources from cost centers associated with resources they administer.", "tags": [ "billing" ], @@ -178650,6 +178651,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -202917,6 +202919,309 @@ } } }, + "/orgs/{org}/credential-authorizations/revoke-all": { + "post": { + "summary": "Revoke all credential authorizations for an organization", + "description": "Revokes all SAML SSO credential authorizations for every member of the\norganization. This removes the sign-in authorizations for personal access\ntokens, SSH keys, OAuth app tokens, and user-to-server tokens that members\nhave authorized for the organization. Members will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, that token's\n> authorization for the organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-all-credential-authorizations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nacross the organization. This removes the sign-in authorizations for that\ncredential type for every member of the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and revoke classic\n> personal access tokens, that token's authorization for the organization may\n> also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke across the organization.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/credential-authorizations/{credential_id}": { "delete": { "summary": "Remove a SAML SSO authorization for an organization", @@ -202987,6 +203292,327 @@ } } }, + "/orgs/{org}/credential-authorizations/{username}/revoke": { + "post": { + "summary": "Revoke credential authorizations for a user in an organization", + "description": "Revokes all SAML SSO credential authorizations for a single user within the\norganization. This removes the sign-in authorizations for the user's personal\naccess tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they\nhave authorized for the organization. The user will need to authorize their\ncredentials again to access the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint and target yourself,\n> that token's authorization for the organization may also be revoked as part of\n> this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-authorizations-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential authorization revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": { + "post": { + "summary": "Revoke a single credential type for a user in an organization", + "description": "Revokes a single credential type (for example, classic personal access tokens)\nfor a single user within the organization. This removes the sign-in authorizations\nfor that credential type for the user in the organization.\n\nThis operation is performed asynchronously. A background job will be queued to process\nthe revocations.\n\n> [!WARNING]\n> If you use a personal access token to call this endpoint, target yourself, and\n> revoke classic personal access tokens, that token's authorization for the\n> organization may also be revoked as part of this operation.\n\nThe authenticated user must be an organization owner to use this endpoint.\n\nOAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/revoke-credential-type-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "description": "The organization name. The name is not case sensitive.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "description": "The handle for the GitHub user account.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "required": true, + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "credential_type" + ], + "properties": { + "credential_type": { + "type": "string", + "description": "The type of credential to revoke for the user.", + "enum": [ + "classic_pat", + "fine_grained_pat", + "ssh_key", + "oauth_app_token" + ] + } + } + }, + "examples": { + "default": { + "value": { + "credential_type": "classic_pat" + } + } + } + } + } + }, + "responses": { + "202": { + "description": "Accepted - The revocation request has been queued", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A message indicating the revocation has been queued" + }, + "warning": { + "type": "string", + "description": "A warning message if the token used for this request may be revoked" + } + } + }, + "examples": { + "default": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued" + } + }, + "with_warning": { + "value": { + "message": "Credential type revocation for user 'octocat' has been queued", + "warning": "The token used for this request may also have its authorization revoked as part of this operation" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource not found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation error - The `credential_type` is missing or invalid", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "status": { + "type": "string" + } + } + }, + "examples": { + "invalid_credential_type": { + "summary": "Missing or invalid `credential_type`", + "value": { + "message": "The `credential_type` parameter is required and must be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token", + "documentation_url": "https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": true, + "enabledForGitHubApps": true, + "category": "orgs", + "subcategory": "orgs" + } + } + }, "/orgs/{org}/custom-repository-roles": { "get": { "summary": "List custom repository roles in an organization", @@ -281366,6 +281992,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -281382,6 +282012,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -281481,22 +282116,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 } @@ -350575,7 +351204,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -350592,6 +351222,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -350599,6 +351230,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -351049,7 +351681,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -351111,7 +351744,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -357701,7 +358335,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -357738,6 +358373,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -357761,6 +358397,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -360738,6 +361375,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -360761,6 +361399,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -364582,6 +365221,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -364605,6 +365245,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -367613,6 +368254,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -367620,6 +368262,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -368915,6 +369558,7 @@ "id": { "description": "The id of the job.", "type": "integer", + "format": "int64", "examples": [ 21 ] @@ -368922,6 +369566,7 @@ "run_id": { "description": "The id of the associated workflow run.", "type": "integer", + "format": "int64", "examples": [ 5 ] @@ -373261,7 +373906,8 @@ "description": "Returns workflow runs with the `check_suite_id` that you specify.", "in": "query", "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -373298,6 +373944,7 @@ "properties": { "id": { "type": "integer", + "format": "int64", "description": "The ID of the workflow run.", "examples": [ 5 @@ -373321,6 +373968,7 @@ }, "check_suite_id": { "type": "integer", + "format": "int64", "description": "The ID of the associated check suite.", "examples": [ 42 @@ -411497,7 +412145,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -412863,7 +413512,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -414495,7 +415145,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } }, { @@ -414694,7 +415345,8 @@ "in": "path", "required": true, "schema": { - "type": "integer" + "type": "integer", + "format": "int64" } } ], @@ -425397,6 +426049,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -426472,6 +427125,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -431518,6 +432172,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -431826,6 +432481,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -460156,7 +460812,7 @@ }, "post": { "summary": "Create a commit comment", - "description": "Create a comment for a commit using its `:commit_sha`.\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", + "description": "Create a comment for a commit using its `:commit_sha`.\n\nAccess to commit comments can be controlled by organization owners. For more information, see \"[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)\".\n\nThis endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see \"[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)\" and \"[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api).\"\n\nThis endpoint supports the following custom media types. For more information, see \"[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types).\"\n\n- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.\n- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.\n- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body's markdown. Response will include `body_html`.\n- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.", "tags": [ "repos" ], @@ -814639,7 +815295,7 @@ "/search/code": { "get": { "summary": "Search code", - "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\n> [!NOTE]\n> `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", + "description": "Searches for query terms inside of a file. This method returns up to 100 results [per page](https://docs.github.com/enterprise-cloud@latest/rest/guides/using-pagination-in-the-rest-api).\n\nWhen searching for code, you can get text match metadata for the file **content** and file **path** fields when you pass the `text-match` media type. For more details about how to receive highlighted search results, see [Text match metadata](https://docs.github.com/enterprise-cloud@latest/rest/search/search#text-match-metadata).\n\nFor example, if you want to find the definition of the `addClass` function inside [jQuery](https://github.com/jquery/jquery) repository, your query would look something like this:\n\n`q=addClass+in:file+language:js+repo:jquery/jquery`\n\nThis query searches for the keyword `addClass` within a file's contents. The query limits the search to files where the language is JavaScript in the `jquery/jquery` repository.\n\nConsiderations for code search:\n\nDue to the complexity of searching code, there are a few restrictions on how searches are performed:\n\n* Only the _default branch_ is considered. In most cases, this will be the `master` branch.\n* Only files smaller than 384 KB are searchable.\n* You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing\nlanguage:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is.\n\nThis endpoint requires you to authenticate and limits you to 10 requests per minute.", "tags": [ "search" ], @@ -967516,6 +968172,10 @@ "iteration_configuration": { "type": "object", "description": "The configuration for iteration fields.", + "required": [ + "start_date", + "duration" + ], "properties": { "start_date": { "type": "string", @@ -967532,6 +968192,11 @@ "items": { "type": "object", "additionalProperties": false, + "required": [ + "title", + "start_date", + "duration" + ], "properties": { "title": { "type": "string", @@ -967631,22 +968296,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 } @@ -1068871,6 +1069530,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1071356,6 +1072016,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1073699,7 +1074360,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1076410,6 +1077071,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1078831,7 +1079493,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "string", "null" @@ -1081271,7 +1081933,7 @@ "maxLength": 280 }, "dismissed_reason": { - "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "description": "The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, `used in tests`, and `mitigated`.", "type": [ "null" ] @@ -1083760,6 +1084422,7 @@ "false positive", "won't fix", "used in tests", + "mitigated", null ] }, @@ -1249718,7 +1250381,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", @@ -1252921,7 +1253584,7 @@ } }, "repositories_removed": { - "description": "An array of repository objects, which were removed from the installation.", + "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "type": "array", "items": { "type": "object", diff --git a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml index 32529f3d4f..66986813c8 100644 --- a/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml +++ b/descriptions-next/ghec/dereferenced/ghec.2022-11-28.deref.yaml @@ -16601,6 +16601,7 @@ paths: - false positive - won't fix - used in tests + - mitigated - dismissed_comment: &568 type: @@ -28931,7 +28932,7 @@ paths: get: summary: Get all budgets description: |- - Gets all budgets for an enterprise. The authenticated actor must have permission to view enterprise billing. + Gets budgets for an enterprise. Enterprise owners and billing managers can view all budgets. Organization administrators can view budgets scoped to organizations and repositories they administer. Each page returns up to 100 budgets. tags: - billing @@ -29190,7 +29191,7 @@ paths: '403': *27 x-github: githubCloudOnly: true - enabledForGitHubApps: true + enabledForGitHubApps: false category: billing subcategory: budgets post: @@ -29437,8 +29438,9 @@ paths: "/enterprises/{enterprise}/settings/billing/budgets/{budget_id}": get: summary: Get a budget by ID - description: Gets a budget by ID. The authenticated user must be an enterprise - admin or billing manager. + description: Gets a budget by ID. Enterprise owners and billing managers can + view any budget in the enterprise. Organization administrators can view budgets + scoped to organizations and repositories they administer. tags: - billing operationId: billing/get-budget @@ -29831,8 +29833,10 @@ paths: subcategory: budgets delete: summary: Delete a budget - description: Deletes a budget by ID. The authenticated user must be an enterprise - admin. + description: Deletes a budget by ID. Enterprise owners and billing managers + can delete any budget in the enterprise. Organization administrators can delete + budgets scoped to organizations they administer, and repository administrators + can delete budgets scoped to repositories they administer. tags: - billing operationId: billing/delete-budget @@ -29878,7 +29882,9 @@ paths: get: summary: Get user states for a multi-user budget description: Lists per-user budget state for a multi-user customer scoped budget. - The authenticated user must be an enterprise admin or billing manager. + Enterprise owners and billing managers can view state across the enterprise. + Organization administrators can view state for budgets scoped to organizations + they administer. tags: - billing operationId: billing/get-budget-user-states @@ -29991,7 +29997,9 @@ paths: "/enterprises/{enterprise}/settings/billing/cost-centers": get: summary: Get all cost centers for an enterprise - description: Gets a list of all the cost centers for an enterprise. + description: Gets a list of all the cost centers for an enterprise. Enterprise + owners and billing managers can view all cost centers. Organization owners + can view cost centers associated with resources they administer. tags: - billing operationId: billing/get-all-cost-centers @@ -30129,7 +30137,7 @@ paths: post: summary: Create a new cost center description: Creates a new cost center for an enterprise. The authenticated - user must be an enterprise admin. + user must be an enterprise owner or billing manager. tags: - billing operationId: billing/create-cost-center @@ -30291,8 +30299,9 @@ paths: "/enterprises/{enterprise}/settings/billing/cost-centers/{cost_center_id}": get: summary: Get a cost center by ID - description: Gets a cost center by ID. The authenticated user must be an enterprise - admin. + description: Gets a cost center by ID. Enterprise owners and billing managers + can view any cost center. Organization owners can view cost centers associated + with resources they administer. tags: - billing operationId: billing/get-cost-center @@ -30412,7 +30421,9 @@ paths: subcategory: cost-centers patch: summary: Update a cost center - description: Updates an existing cost center. + description: Updates an existing cost center. Enterprise owners and billing + managers can update any cost center. Organization owners can update cost centers + associated with resources they administer. tags: - billing operationId: billing/update-cost-center @@ -30555,8 +30566,9 @@ paths: subcategory: cost-centers delete: summary: Delete a cost center - description: Archieves a cost center by ID. The authenticated user must be an - enterprise admin. + description: Archives a cost center by ID. Enterprise owners and billing managers + can archive any cost center. Organization owners can archive cost centers + associated with resources they administer. tags: - billing operationId: billing/delete-cost-center @@ -30616,7 +30628,7 @@ paths: description: |- Adds resources to a cost center. - The usage for the resources will be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. + The usage for the resources will be charged to the cost center's budget. Enterprise owners and billing managers can add any resource. Organization owners can add non-team resources to cost centers associated with resources they administer. tags: - billing operationId: billing/add-resource-to-cost-center @@ -30717,7 +30729,7 @@ paths: description: |- Remove resources from a cost center. - The usage for the resources will no longer be charged to the cost center's budget. The authenticated user must be an enterprise admin in order to use this endpoint. + The usage for the resources will no longer be charged to the cost center's budget. Enterprise owners and billing managers can remove any resource. Organization owners can remove non-team resources from cost centers associated with resources they administer. tags: - billing operationId: billing/remove-resource-from-cost-center @@ -53916,6 +53928,156 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-all": + post: + summary: Revoke all credential authorizations for an organization + description: |- + Revokes all SAML SSO credential authorizations for every member of the + organization. This removes the sign-in authorizations for personal access + tokens, SSH keys, OAuth app tokens, and user-to-server tokens that members + have authorized for the organization. Members will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, that token's + > authorization for the organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-all-credential-authorizations + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-all-credential-authorizations-for-an-organization + parameters: + - *88 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation has been queued + with_warning: + value: + message: Credential authorization revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/revoke-credential-type": + post: + summary: Revoke a single credential type for an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + across the organization. This removes the sign-in authorizations for that + credential type for every member of the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and revoke classic + > personal access tokens, that token's authorization for the organization may + > also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + parameters: + - *88 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke across the organization. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation has been queued + with_warning: + value: + message: Credential type revocation has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/credential-authorizations/{credential_id}": delete: summary: Remove a SAML SSO authorization for an organization @@ -53947,6 +54109,163 @@ paths: enabledForGitHubApps: true category: orgs subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke": + post: + summary: Revoke credential authorizations for a user in an organization + description: |- + Revokes all SAML SSO credential authorizations for a single user within the + organization. This removes the sign-in authorizations for the user's personal + access tokens, SSH keys, OAuth app tokens, and user-to-server tokens that they + have authorized for the organization. The user will need to authorize their + credentials again to access the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint and target yourself, + > that token's authorization for the organization may also be revoked as part of + > this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-authorizations-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-credential-authorizations-for-a-user-in-an-organization + parameters: + - *88 + - *131 + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + with_warning: + value: + message: Credential authorization revocation for user 'octocat' + has been queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs + "/orgs/{org}/credential-authorizations/{username}/revoke-credential-type": + post: + summary: Revoke a single credential type for a user in an organization + description: |- + Revokes a single credential type (for example, classic personal access tokens) + for a single user within the organization. This removes the sign-in authorizations + for that credential type for the user in the organization. + + This operation is performed asynchronously. A background job will be queued to process + the revocations. + + > [!WARNING] + > If you use a personal access token to call this endpoint, target yourself, and + > revoke classic personal access tokens, that token's authorization for the + > organization may also be revoked as part of this operation. + + The authenticated user must be an organization owner to use this endpoint. + + OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. + tags: + - orgs + operationId: orgs/revoke-credential-type-for-user + externalDocs: + description: API method documentation + url: https://docs.github.com/enterprise-cloud@latest/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + parameters: + - *88 + - *131 + requestBody: + required: true + content: + application/json: + schema: + type: object + required: + - credential_type + properties: + credential_type: + type: string + description: The type of credential to revoke for the user. + enum: + - classic_pat + - fine_grained_pat + - ssh_key + - oauth_app_token + examples: + default: + value: + credential_type: classic_pat + responses: + '202': + description: Accepted - The revocation request has been queued + content: + application/json: + schema: + type: object + properties: + message: + type: string + description: A message indicating the revocation has been queued + warning: + type: string + description: A warning message if the token used for this request + may be revoked + examples: + default: + value: + message: Credential type revocation for user 'octocat' has been + queued + with_warning: + value: + message: Credential type revocation for user 'octocat' has been + queued + warning: The token used for this request may also have its authorization + revoked as part of this operation + '403': *27 + '404': *6 + '422': + description: Validation error - The `credential_type` is missing or invalid + content: + application/json: + schema: *3 + examples: + invalid_credential_type: + summary: Missing or invalid `credential_type` + value: + message: 'The `credential_type` parameter is required and must + be one of: classic_pat, fine_grained_pat, ssh_key, oauth_app_token' + documentation_url: https://docs.github.com/rest/orgs/orgs#revoke-a-single-credential-type-for-a-user-in-an-organization + x-github: + githubCloudOnly: true + enabledForGitHubApps: true + category: orgs + subcategory: orgs "/orgs/{org}/custom-repository-roles": get: summary: List custom repository roles in an organization @@ -65116,6 +65435,9 @@ paths: iteration_configuration: &890 type: object description: The configuration for iteration fields. + required: + - start_date + - duration properties: start_date: type: string @@ -65131,6 +65453,10 @@ paths: items: type: object additionalProperties: false + required: + - title + - start_date + - duration properties: title: type: string @@ -65196,17 +65522,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: @@ -75719,6 +76041,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -75732,11 +76055,13 @@ paths: id: description: The id of the job. type: integer + format: int64 examples: - 21 run_id: description: The id of the associated workflow run. type: integer + format: int64 examples: - 5 run_url: @@ -77556,6 +77881,7 @@ paths: in: query schema: type: integer + format: int64 - &534 name: head_sha description: Only returns workflow runs that are associated with the specified @@ -77586,6 +77912,7 @@ paths: properties: id: type: integer + format: int64 description: The ID of the workflow run. examples: - 5 @@ -77602,6 +77929,7 @@ paths: - MDEwOkNoZWNrU3VpdGU1 check_suite_id: type: integer + format: int64 description: The ID of the associated check suite. examples: - 42 @@ -86402,6 +86730,7 @@ paths: required: true schema: type: integer + format: int64 responses: '200': description: Response @@ -93708,6 +94037,8 @@ paths: description: |- Create a comment for a commit using its `:commit_sha`. + Access to commit comments can be controlled by organization owners. For more information, see "[Managing commit comments for your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-commit-comments-for-your-organization)". + This endpoint triggers [notifications](https://docs.github.com/enterprise-cloud@latest/github/managing-subscriptions-and-notifications-on-github/about-notifications). Creating content too quickly using this endpoint may result in secondary rate limiting. For more information, see "[Rate limits for the API](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/rate-limits-for-the-rest-api#about-secondary-rate-limits)" and "[Best practices for using the REST API](https://docs.github.com/enterprise-cloud@latest/rest/guides/best-practices-for-using-the-rest-api)." This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-cloud@latest/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)." @@ -128824,9 +129155,6 @@ paths: * You must always include at least one search term when searching source code. For example, searching for [`language:go`](https://github.com/search?utf8=%E2%9C%93&q=language%3Ago&type=Code) is not valid, while [`amazing language:go`](https://github.com/search?utf8=%E2%9C%93&q=amazing+language%3Ago&type=Code) is. - > [!NOTE] - > `repository.description`, `repository.owner.type`, and `repository.owner.node_id` are closing down on this endpoint and will return `null` in a future API version. Use the [Get a repository](https://docs.github.com/enterprise-cloud@latest/rest/repos/repos#get-a-repository) endpoint (`GET /repos/{owner}/{repo}`) to retrieve full repository metadata. - This endpoint requires you to authenticate and limits you to 10 requests per minute. tags: - search @@ -149250,6 +149578,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149582,6 +149911,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -149919,8 +150249,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - 'null' fixed_at: @@ -150285,6 +150615,7 @@ webhooks: - false positive - won't fix - used in tests + - mitigated - fixed_at: description: 'The time that the alert was fixed in ISO 8601 @@ -150561,8 +150892,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + Can be one of: `false positive`, `won''t fix`, `used in tests`, + and `mitigated`.' type: - string - 'null' @@ -150859,8 +151190,8 @@ webhooks: dismissed_comment: *568 dismissed_reason: description: 'The reason for dismissing or closing the alert. - Can be one of: `false positive`, `won''t fix`, and `used in - tests`.' + {"code":"deadline_exceeded","msg":"operation timed out"}