|
14836 | 14836 | },
|
14837 | 14837 | "repository-dispatch-sample.collected": {
|
14838 | 14838 | "post": {
|
14839 |
| - "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", |
14840 |
| - "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.", |
| 14839 | + "summary": "This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", |
14841 | 14840 | "operationId": "repository-dispatch/sample.collected",
|
14842 | 14841 | "externalDocs": {
|
14843 | 14842 | "url": "https://docs.github.com/webhooks/webhook-events-and-payloads#repository_dispatch"
|
|
18590 | 18589 | "followers_url": { "type": "string", "format": "uri-template" },
|
18591 | 18590 | "following_url": { "type": "string", "format": "uri-template" },
|
18592 | 18591 | "gists_url": { "type": "string", "format": "uri-template" },
|
18593 |
| - "hub_url": { "type": "string", "format": "uri-template" }, |
| 18592 | + "hub_url": { |
| 18593 | + "type": "string", |
| 18594 | + "format": "uri-template", |
| 18595 | + "deprecated": true |
| 18596 | + }, |
18594 | 18597 | "issue_search_url": { "type": "string", "format": "uri-template" },
|
18595 | 18598 | "issues_url": { "type": "string", "format": "uri-template" },
|
18596 | 18599 | "keys_url": { "type": "string", "format": "uri-template" },
|
|
18643 | 18646 | "followers_url",
|
18644 | 18647 | "following_url",
|
18645 | 18648 | "gists_url",
|
18646 |
| - "hub_url", |
18647 | 18649 | "issue_search_url",
|
18648 | 18650 | "issues_url",
|
18649 | 18651 | "keys_url",
|
@@ -24895,11 +24897,21 @@
|
24895 | 24897 | "description": "The organization policy for allowing or disallowing Copilot to make suggestions that match public code.",
|
24896 | 24898 | "enum": ["allow", "block", "unconfigured", "unknown"]
|
24897 | 24899 | },
|
24898 |
| - "copilot_chat": { |
| 24900 | + "ide_chat": { |
24899 | 24901 | "type": "string",
|
24900 | 24902 | "description": "The organization policy for allowing or disallowing organization members to use Copilot Chat within their editor.",
|
24901 | 24903 | "enum": ["enabled", "disabled", "unconfigured"]
|
24902 | 24904 | },
|
| 24905 | + "platform_chat": { |
| 24906 | + "type": "string", |
| 24907 | + "description": "The organization policy for allowing or disallowing organization members to use Copilot features within github.com.", |
| 24908 | + "enum": ["enabled", "disabled", "unconfigured"] |
| 24909 | + }, |
| 24910 | + "cli": { |
| 24911 | + "type": "string", |
| 24912 | + "description": "The organization policy for allowing or disallowing organization members to use Copilot within their CLI.", |
| 24913 | + "enum": ["enabled", "disabled", "unconfigured"] |
| 24914 | + }, |
24903 | 24915 | "seat_management_setting": {
|
24904 | 24916 | "type": "string",
|
24905 | 24917 | "description": "The mode of assigning new seats.",
|
|
27169 | 27181 | }
|
27170 | 27182 | }
|
27171 | 27183 | },
|
| 27184 | + "repository-rule-params-code-scanning-threshold": { |
| 27185 | + "title": "CodeScanningThreshold", |
| 27186 | + "description": "A tool and its thresholds.", |
| 27187 | + "type": "object", |
| 27188 | + "properties": { |
| 27189 | + "alerts": { |
| 27190 | + "type": "string", |
| 27191 | + "description": "Code scanning alert threshold", |
| 27192 | + "enum": ["none", "errors", "errors_and_warnings", "all"] |
| 27193 | + }, |
| 27194 | + "security_alerts": { |
| 27195 | + "type": "string", |
| 27196 | + "description": "Code scanning security alert threshold.", |
| 27197 | + "enum": [ |
| 27198 | + "none", |
| 27199 | + "critical", |
| 27200 | + "high_or_higher", |
| 27201 | + "medium_or_higher", |
| 27202 | + "all" |
| 27203 | + ] |
| 27204 | + }, |
| 27205 | + "tool": { |
| 27206 | + "type": "string", |
| 27207 | + "description": "The name of a code scanning tool" |
| 27208 | + } |
| 27209 | + }, |
| 27210 | + "required": ["alerts", "security_alerts", "tool"] |
| 27211 | + }, |
27172 | 27212 | "repository-rule": {
|
27173 | 27213 | "title": "Repository Rule",
|
27174 | 27214 | "type": "object",
|
|
29326 | 29366 | "status": {
|
29327 | 29367 | "description": "The phase of the lifecycle that the job is currently in.",
|
29328 | 29368 | "type": "string",
|
29329 |
| - "enum": ["queued", "in_progress", "completed", "waiting"], |
| 29369 | + "enum": [ |
| 29370 | + "queued", |
| 29371 | + "in_progress", |
| 29372 | + "completed", |
| 29373 | + "waiting", |
| 29374 | + "requested", |
| 29375 | + "pending" |
| 29376 | + ], |
29330 | 29377 | "examples": ["queued"]
|
29331 | 29378 | },
|
29332 | 29379 | "conclusion": {
|
|
31397 | 31444 | "examples": ["https://example.com"]
|
31398 | 31445 | },
|
31399 | 31446 | "status": {
|
31400 |
| - "description": "The phase of the lifecycle that the check is currently in.", |
| 31447 | + "description": "The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.", |
31401 | 31448 | "type": "string",
|
31402 |
| - "enum": ["queued", "in_progress", "completed"], |
| 31449 | + "enum": [ |
| 31450 | + "queued", |
| 31451 | + "in_progress", |
| 31452 | + "completed", |
| 31453 | + "waiting", |
| 31454 | + "requested", |
| 31455 | + "pending" |
| 31456 | + ], |
31403 | 31457 | "examples": ["queued"]
|
31404 | 31458 | },
|
31405 | 31459 | "conclusion": {
|
|
31541 | 31595 | },
|
31542 | 31596 | "status": {
|
31543 | 31597 | "type": ["string", "null"],
|
31544 |
| - "enum": ["queued", "in_progress", "completed", null], |
| 31598 | + "description": "The phase of the lifecycle that the check suite is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check suites.", |
| 31599 | + "enum": [ |
| 31600 | + "queued", |
| 31601 | + "in_progress", |
| 31602 | + "completed", |
| 31603 | + "waiting", |
| 31604 | + "requested", |
| 31605 | + "pending", |
| 31606 | + null |
| 31607 | + ], |
31545 | 31608 | "examples": ["completed"]
|
31546 | 31609 | },
|
31547 | 31610 | "conclusion": {
|
|
38084 | 38147 | "commit_url"
|
38085 | 38148 | ]
|
38086 | 38149 | },
|
| 38150 | + "secret-scanning-location-wiki-commit": { |
| 38151 | + "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", |
| 38152 | + "type": "object", |
| 38153 | + "properties": { |
| 38154 | + "path": { |
| 38155 | + "type": "string", |
| 38156 | + "description": "The file path of the wiki page", |
| 38157 | + "examples": ["/example/Home.md"] |
| 38158 | + }, |
| 38159 | + "start_line": { |
| 38160 | + "type": "number", |
| 38161 | + "description": "Line number at which the secret starts in the file" |
| 38162 | + }, |
| 38163 | + "end_line": { |
| 38164 | + "type": "number", |
| 38165 | + "description": "Line number at which the secret ends in the file" |
| 38166 | + }, |
| 38167 | + "start_column": { |
| 38168 | + "type": "number", |
| 38169 | + "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." |
| 38170 | + }, |
| 38171 | + "end_column": { |
| 38172 | + "type": "number", |
| 38173 | + "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." |
| 38174 | + }, |
| 38175 | + "blob_sha": { |
| 38176 | + "type": "string", |
| 38177 | + "description": "SHA-1 hash ID of the associated blob", |
| 38178 | + "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] |
| 38179 | + }, |
| 38180 | + "page_url": { |
| 38181 | + "type": "string", |
| 38182 | + "description": "The GitHub URL to get the associated wiki page", |
| 38183 | + "examples": [ |
| 38184 | + "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" |
| 38185 | + ] |
| 38186 | + }, |
| 38187 | + "commit_sha": { |
| 38188 | + "type": "string", |
| 38189 | + "description": "SHA-1 hash ID of the associated commit", |
| 38190 | + "examples": ["302c0b7e200761c9dd9b57e57db540ee0b4293a5"] |
| 38191 | + }, |
| 38192 | + "commit_url": { |
| 38193 | + "type": "string", |
| 38194 | + "description": "The GitHub URL to get the associated wiki commit", |
| 38195 | + "examples": [ |
| 38196 | + "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" |
| 38197 | + ] |
| 38198 | + } |
| 38199 | + }, |
| 38200 | + "required": [ |
| 38201 | + "path", |
| 38202 | + "start_line", |
| 38203 | + "end_line", |
| 38204 | + "start_column", |
| 38205 | + "end_column", |
| 38206 | + "blob_sha", |
| 38207 | + "page_url", |
| 38208 | + "commit_sha", |
| 38209 | + "commit_url" |
| 38210 | + ] |
| 38211 | + }, |
38087 | 38212 | "secret-scanning-location-issue-title": {
|
38088 | 38213 | "description": "Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue.",
|
38089 | 38214 | "type": "object",
|
|
38256 | 38381 | "type": "string",
|
38257 | 38382 | "enum": [
|
38258 | 38383 | "commit",
|
| 38384 | + "wiki_commit", |
38259 | 38385 | "issue_title",
|
38260 | 38386 | "issue_body",
|
38261 | 38387 | "issue_comment",
|
|
38276 | 38402 | {
|
38277 | 38403 | "$ref": "#/components/schemas/secret-scanning-location-commit"
|
38278 | 38404 | },
|
| 38405 | + { |
| 38406 | + "$ref": "#/components/schemas/secret-scanning-location-wiki-commit" |
| 38407 | + }, |
38279 | 38408 | {
|
38280 | 38409 | "$ref": "#/components/schemas/secret-scanning-location-issue-title"
|
38281 | 38410 | },
|
|
38311 | 38440 | }
|
38312 | 38441 | ]
|
38313 | 38442 | }
|
38314 |
| - }, |
38315 |
| - "required": ["type", "details"] |
| 38443 | + } |
38316 | 38444 | },
|
38317 | 38445 | "repository-advisory-create": {
|
38318 | 38446 | "type": "object",
|
@@ -70430,11 +70558,18 @@
|
70430 | 70558 | "type": "object",
|
70431 | 70559 | "properties": {
|
70432 | 70560 | "permission": {
|
| 70561 | + "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole name, including custom roles.", |
70433 | 70562 | "type": "object",
|
70434 | 70563 | "properties": {
|
70435 | 70564 | "to": { "type": "string", "enum": ["write", "admin", "read"] }
|
70436 | 70565 | },
|
70437 | 70566 | "required": ["to"]
|
| 70567 | + }, |
| 70568 | + "role_name": { |
| 70569 | + "description": "The role assigned to the collaborator.", |
| 70570 | + "type": "object", |
| 70571 | + "properties": { "to": { "type": "string" } }, |
| 70572 | + "required": ["to"] |
70438 | 70573 | }
|
70439 | 70574 | }
|
70440 | 70575 | },
|
@@ -123199,7 +123334,7 @@
|
123199 | 123334 | "type": "string"
|
123200 | 123335 | },
|
123201 | 123336 | "commits": {
|
123202 |
| - "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 20 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits. This limit is applied to timeline events only and isn't applied to webhook deliveries.", |
| 123337 | + "description": "An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/rest/commits) to fetch additional commits.", |
123203 | 123338 | "type": "array",
|
123204 | 123339 | "items": {
|
123205 | 123340 | "title": "Commit",
|
@@ -126477,11 +126612,15 @@
|
126477 | 126612 | "title": "repository_dispatch event",
|
126478 | 126613 | "type": "object",
|
126479 | 126614 | "properties": {
|
126480 |
| - "action": { "type": "string", "enum": ["sample.collected"] }, |
| 126615 | + "action": { |
| 126616 | + "type": "string", |
| 126617 | + "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." |
| 126618 | + }, |
126481 | 126619 | "branch": { "type": "string" },
|
126482 | 126620 | "client_payload": {
|
126483 | 126621 | "type": ["object", "null"],
|
126484 |
| - "additionalProperties": true |
| 126622 | + "additionalProperties": true, |
| 126623 | + "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." |
126485 | 126624 | },
|
126486 | 126625 | "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" },
|
126487 | 126626 | "installation": {
|
@@ -156714,6 +156853,20 @@
|
156714 | 156853 | "commit_url": "https://api.github.com/repos/octocat/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b"
|
156715 | 156854 | }
|
156716 | 156855 | },
|
| 156856 | + { |
| 156857 | + "type": "wiki_commit", |
| 156858 | + "details": { |
| 156859 | + "path": "/example/Home.md", |
| 156860 | + "start_line": 1, |
| 156861 | + "end_line": 1, |
| 156862 | + "start_column": 1, |
| 156863 | + "end_column": 64, |
| 156864 | + "blob_sha": "af5626b4a114abcb82d63db7c8082c3c4756e51b", |
| 156865 | + "page_url": "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5", |
| 156866 | + "commit_sha": "302c0b7e200761c9dd9b57e57db540ee0b4293a5", |
| 156867 | + "commit_url": "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" |
| 156868 | + } |
| 156869 | + }, |
156717 | 156870 | {
|
156718 | 156871 | "type": "issue_title",
|
156719 | 156872 | "details": {
|
@@ -163743,7 +163896,7 @@
|
163743 | 163896 | },
|
163744 | 163897 | "workflow-run-status": {
|
163745 | 163898 | "name": "status",
|
163746 |
| - "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`.", |
| 163899 | + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub Actions can set a status of `waiting`, `pending`, or `requested`.", |
163747 | 163900 | "in": "query",
|
163748 | 163901 | "required": false,
|
163749 | 163902 | "schema": {
|
@@ -163938,6 +164091,15 @@
|
163938 | 164091 | "required": true,
|
163939 | 164092 | "schema": { "type": "integer" }
|
163940 | 164093 | },
|
| 164094 | + "git-ref-only": { |
| 164095 | + "name": "ref", |
| 164096 | + "description": "The Git reference. For more information, see \"[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)\" in the Git documentation.", |
| 164097 | + "in": "path", |
| 164098 | + "required": true, |
| 164099 | + "example": "heads/feature-a", |
| 164100 | + "schema": { "type": "string" }, |
| 164101 | + "x-multi-segment": true |
| 164102 | + }, |
163941 | 164103 | "since-user": {
|
163942 | 164104 | "name": "since",
|
163943 | 164105 | "description": "A user ID. Only return users with an ID greater than this ID.",
|
@@ -164352,6 +164514,14 @@
|
164352 | 164514 | "schema": { "$ref": "#/components/schemas/basic-error" }
|
164353 | 164515 | }
|
164354 | 164516 | }
|
| 164517 | + }, |
| 164518 | + "unacceptable": { |
| 164519 | + "description": "Unacceptable", |
| 164520 | + "content": { |
| 164521 | + "application/json": { |
| 164522 | + "schema": { "$ref": "#/components/schemas/basic-error" } |
| 164523 | + } |
| 164524 | + } |
164355 | 164525 | }
|
164356 | 164526 | },
|
164357 | 164527 | "headers": {
|
|
0 commit comments