Skip to content

Commit 54fe47a

Browse files
docs-botsubatoi
andauthored
Update OpenAPI Description (#60693)
Co-authored-by: Ben Ahmady <32935794+subatoi@users.noreply.github.com>
1 parent a83d5c7 commit 54fe47a

File tree

24 files changed

+654
-814
lines changed

24 files changed

+654
-814
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": "3d5beeaa2dab037828a246d389b492f18a0b35ad"
63+
"sha": "36e6d2087a74bda6b56e450420eee3427798bc75"
6464
}

src/rest/data/fpt-2022-11-28/agent-tasks.json

Lines changed: 67 additions & 181 deletions
Large diffs are not rendered by default.

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

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2616,7 +2616,7 @@
26162616
}
26172617
],
26182618
"bodyParameters": [],
2619-
"descriptionHTML": "<p>Gets a specified gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
2619+
"descriptionHTML": "<p>Gets a specified gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
26202620
"codeExamples": [
26212621
{
26222622
"request": {
@@ -3768,7 +3768,7 @@
37683768
]
37693769
}
37703770
],
3771-
"descriptionHTML": "<p>Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.</p>\n<p>At least one of <code>description</code> or <code>files</code> is required.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
3771+
"descriptionHTML": "<p>Allows you to update a gist's description and to update, delete, or rename gist files. Files\nfrom the previous version of the gist that aren't explicitly changed during an edit\nare unchanged.</p>\n<p>At least one of <code>description</code> or <code>files</code> is required.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
37723772
"codeExamples": [
37733773
{
37743774
"request": {
@@ -9157,7 +9157,7 @@
91579157
}
91589158
],
91599159
"bodyParameters": [],
9160-
"descriptionHTML": "<p>Gets a specified gist revision.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
9160+
"descriptionHTML": "<p>Gets a specified gist revision.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
91619161
"codeExamples": [
91629162
{
91639163
"request": {
@@ -10785,7 +10785,7 @@
1078510785
}
1078610786
],
1078710787
"bodyParameters": [],
10788-
"descriptionHTML": "<p>Lists the comments on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
10788+
"descriptionHTML": "<p>Lists the comments on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
1078910789
"codeExamples": [
1079010790
{
1079110791
"request": {
@@ -11062,7 +11062,7 @@
1106211062
"isRequired": true
1106311063
}
1106411064
],
11065-
"descriptionHTML": "<p>Creates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
11065+
"descriptionHTML": "<p>Creates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
1106611066
"codeExamples": [
1106711067
{
1106811068
"request": {
@@ -11344,7 +11344,7 @@
1134411344
}
1134511345
],
1134611346
"bodyParameters": [],
11347-
"descriptionHTML": "<p>Gets a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
11347+
"descriptionHTML": "<p>Gets a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
1134811348
"codeExamples": [
1134911349
{
1135011350
"request": {
@@ -11627,7 +11627,7 @@
1162711627
"isRequired": true
1162811628
}
1162911629
],
11630-
"descriptionHTML": "<p>Updates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n<li><strong><code>application/vnd.github.base64+json</code></strong>: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.</li>\n</ul>",
11630+
"descriptionHTML": "<p>Updates a comment on a gist.</p>\n<p>This endpoint supports the following custom media types. For more information, see \"<a href=\"https://docs.github.com/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types\">Media types</a>.\"</p>\n<ul>\n<li><strong><code>application/vnd.github.raw+json</code></strong>: Returns the raw markdown. This is the default if you do not pass any specific media type.</li>\n</ul>",
1163111631
"codeExamples": [
1163211632
{
1163311633
"request": {

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

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,16 @@
5151
{
5252
"name": "exclude_providers",
5353
"in": "query",
54-
"description": "<p>A comma-separated list of provider names to exclude from the results.</p>",
54+
"description": "<p>A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., <code>github_secret_scanning</code>, <code>clojars</code>).\nYou can find the provider slug in the <code>provider_slug</code> field of each alert.\nCannot be combined with the <code>providers</code> parameter.</p>",
55+
"required": false,
56+
"schema": {
57+
"type": "string"
58+
}
59+
},
60+
{
61+
"name": "providers",
62+
"in": "query",
63+
"description": "<p>A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., <code>github_secret_scanning</code>, <code>clojars</code>).\nYou can find the provider slug in the <code>provider_slug</code> field of each alert.\nCannot be combined with the <code>exclude_providers</code> parameter.</p>",
5564
"required": false,
5665
"schema": {
5766
"type": "string"
@@ -587,6 +596,13 @@
587596
],
588597
"description": "The provider of the secret that was detected."
589598
},
599+
"provider_slug": {
600+
"type": [
601+
"string",
602+
"null"
603+
],
604+
"description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters."
605+
},
590606
"secret": {
591607
"type": "string",
592608
"description": "The secret that was detected."
@@ -1929,7 +1945,16 @@
19291945
{
19301946
"name": "exclude_providers",
19311947
"in": "query",
1932-
"description": "<p>A comma-separated list of provider names to exclude from the results.</p>",
1948+
"description": "<p>A comma-separated list of provider slugs to exclude from the results.\nProvider slugs use lowercase with underscores (e.g., <code>github_secret_scanning</code>, <code>clojars</code>).\nYou can find the provider slug in the <code>provider_slug</code> field of each alert.\nCannot be combined with the <code>providers</code> parameter.</p>",
1949+
"required": false,
1950+
"schema": {
1951+
"type": "string"
1952+
}
1953+
},
1954+
{
1955+
"name": "providers",
1956+
"in": "query",
1957+
"description": "<p>A comma-separated list of provider slugs to filter by.\nProvider slugs use lowercase with underscores (e.g., <code>github_secret_scanning</code>, <code>clojars</code>).\nYou can find the provider slug in the <code>provider_slug</code> field of each alert.\nCannot be combined with the <code>exclude_providers</code> parameter.</p>",
19331958
"required": false,
19341959
"schema": {
19351960
"type": "string"
@@ -2406,6 +2431,13 @@
24062431
],
24072432
"description": "The provider of the secret that was detected."
24082433
},
2434+
"provider_slug": {
2435+
"type": [
2436+
"string",
2437+
"null"
2438+
],
2439+
"description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters."
2440+
},
24092441
"secret": {
24102442
"type": "string",
24112443
"description": "The secret that was detected."
@@ -3620,6 +3652,13 @@
36203652
],
36213653
"description": "The provider of the secret that was detected."
36223654
},
3655+
"provider_slug": {
3656+
"type": [
3657+
"string",
3658+
"null"
3659+
],
3660+
"description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters."
3661+
},
36233662
"secret": {
36243663
"type": "string",
36253664
"description": "The secret that was detected."
@@ -4903,6 +4942,13 @@
49034942
],
49044943
"description": "The provider of the secret that was detected."
49054944
},
4945+
"provider_slug": {
4946+
"type": [
4947+
"string",
4948+
"null"
4949+
],
4950+
"description": "The slug identifier for the provider of the secret that was detected. Use this value for filtering by provider with the `providers` or `exclude_providers` parameters."
4951+
},
49064952
"secret": {
49074953
"type": "string",
49084954
"description": "The secret that was detected."

0 commit comments

Comments
 (0)