Skip to content

Commit 26ad59c

Browse files
docs-botsubatoi
andauthored
Update OpenAPI Description (#60759)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent 5a2689c commit 26ad59c

39 files changed

+320
-862
lines changed

src/github-apps/lib/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,5 +60,5 @@
6060
"2022-11-28"
6161
]
6262
},
63-
"sha": "3ba1e7273bb94c613cf608640e4a7a860310669b"
63+
"sha": "e6a345665a64530821d4ebcd07e7805a0cdeff09"
6464
}

src/rest/data/fpt-2022-11-28/orgs.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9439,8 +9439,13 @@
94399439
{
94409440
"type": "array of objects",
94419441
"name": "options",
9442-
"description": "<p>Options for single select fields. Only applicable when updating single_select fields.</p>",
9442+
"description": "<p>Options for single select fields. Only applicable when updating single_select fields. When provided, this array <strong>replaces</strong> the entire existing set of options rather than adding to or updating individual options. To retain or update an existing option, include it in the array with its <code>id</code>. Options sent without an <code>id</code> are treated as new options and may cause existing options to be deleted and recreated.</p>",
94439443
"childParamsGroups": [
9444+
{
9445+
"type": "integer",
9446+
"name": "id",
9447+
"description": "<p>The id of an existing option to retain or update. Omit this when creating a new option.</p>"
9448+
},
94449449
{
94459450
"type": "string",
94469451
"name": "name",

src/rest/data/fpt-2022-11-28/secret-scanning.json

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6563,7 +6563,7 @@
65636563
}
65646564
],
65656565
"bodyParameters": [],
6566-
"descriptionHTML": "<p>Lists the latest default incremental and backfill scans by type for a repository. Scans from Copilot Secret Scanning are not included.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint requires <a href=\"https://docs.github.com/get-started/learning-about-github/about-github-advanced-security\">GitHub Advanced Security</a>.\"</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.</p>",
6566+
"descriptionHTML": "<p>Lists the latest default incremental and backfill scans by type for a repository.</p>\n<div class=\"ghd-alert ghd-alert-accent\" data-container=\"alert\"><p class=\"ghd-alert-title\"><svg version=\"1.1\" width=\"16\" height=\"16\" viewBox=\"0 0 16 16\" class=\"octicon mr-2\" aria-hidden><path d=\"M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8Zm8-6.5a6.5 6.5 0 1 0 0 13 6.5 6.5 0 0 0 0-13ZM6.5 7.75A.75.75 0 0 1 7.25 7h1a.75.75 0 0 1 .75.75v2.75h.25a.75.75 0 0 1 0 1.5h-2a.75.75 0 0 1 0-1.5h.25v-2h-.25a.75.75 0 0 1-.75-.75ZM8 6a1 1 0 1 1 0-2 1 1 0 0 1 0 2Z\"></path></svg>Note</p>\n<p>\nThis endpoint requires <a href=\"https://docs.github.com/get-started/learning-about-github/about-github-advanced-security\">GitHub Advanced Security</a>.</p>\n</div>\n<p>OAuth app tokens and personal access tokens (classic) need the <code>repo</code> or <code>security_events</code> scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the <code>public_repo</code> scope instead.</p>",
65676567
"codeExamples": [
65686568
{
65696569
"request": {
@@ -6631,6 +6631,14 @@
66316631
"pattern_slug": "my-custom-pattern",
66326632
"pattern_scope": "organization"
66336633
}
6634+
],
6635+
"generic_secrets_backfill_scans": [
6636+
{
6637+
"type": "git",
6638+
"status": "completed",
6639+
"started_at": "2024-10-07T02:47:00Z",
6640+
"completed_at": "2024-10-07T02:55:00Z"
6641+
}
66346642
]
66356643
},
66366644
"schema": {
@@ -6784,6 +6792,39 @@
67846792
}
67856793
]
67866794
}
6795+
},
6796+
"generic_secrets_backfill_scans": {
6797+
"type": "array",
6798+
"items": {
6799+
"description": "Information on a single scan performed by secret scanning on the repository",
6800+
"type": "object",
6801+
"properties": {
6802+
"type": {
6803+
"type": "string",
6804+
"description": "The type of scan"
6805+
},
6806+
"status": {
6807+
"type": "string",
6808+
"description": "The state of the scan. Either \"completed\", \"running\", or \"pending\""
6809+
},
6810+
"completed_at": {
6811+
"type": [
6812+
"string",
6813+
"null"
6814+
],
6815+
"format": "date-time",
6816+
"description": "The time that the scan was completed. Empty if the scan is running"
6817+
},
6818+
"started_at": {
6819+
"type": [
6820+
"string",
6821+
"null"
6822+
],
6823+
"format": "date-time",
6824+
"description": "The time that the scan was started. Empty if the scan is pending"
6825+
}
6826+
}
6827+
}
67876828
}
67886829
}
67896830
}

src/rest/data/fpt-2026-03-10/gists.json

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5697,7 +5697,6 @@
56975697
"updated_at": "2011-06-20T11:34:15Z",
56985698
"description": "Hello World Examples",
56995699
"comments": 0,
5700-
"user": null,
57015700
"comments_url": "https://api.github.com/gists/aa5a315d61ae9438b18d/comments/",
57025701
"owner": {
57035702
"login": "octocat",

0 commit comments

Comments
 (0)