Skip to content

Commit 862aca9

Browse files
Update OpenAPI Descriptions (github#25816)
1 parent d04e404 commit 862aca9

12 files changed

+41
-41
lines changed

lib/rest/static/decorated/api.github.com.json

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80969,12 +80969,12 @@
8096980969
{
8097080970
"name": "secret_type",
8097180971
"in": "query",
80972-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
80972+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
8097380973
"required": false,
8097480974
"schema": {
8097580975
"type": "string"
8097680976
},
80977-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
80977+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
8097880978
},
8097980979
{
8098080980
"name": "resolution",
@@ -81088,12 +81088,12 @@
8108881088
{
8108981089
"name": "secret_type",
8109081090
"in": "query",
81091-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
81091+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
8109281092
"required": false,
8109381093
"schema": {
8109481094
"type": "string"
8109581095
},
81096-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
81096+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
8109781097
},
8109881098
{
8109981099
"name": "resolution",
@@ -81206,12 +81206,12 @@
8120681206
{
8120781207
"name": "secret_type",
8120881208
"in": "query",
81209-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
81209+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
8121081210
"required": false,
8121181211
"schema": {
8121281212
"type": "string"
8121381213
},
81214-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
81214+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
8121581215
},
8121681216
{
8121781217
"name": "resolution",
@@ -81264,7 +81264,7 @@
8126481264
"category": "secret-scanning",
8126581265
"notes": [],
8126681266
"bodyParameters": [],
81267-
"descriptionHTML": "<p>Lists secret scanning alerts for a private repository, from newest to oldest. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
81267+
"descriptionHTML": "<p>Lists secret scanning alerts for an eligible repository, from newest to oldest.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
8126881268
"responses": [
8126981269
{
8127081270
"httpStatusCode": "200",
@@ -81340,7 +81340,7 @@
8134081340
"category": "secret-scanning",
8134181341
"notes": [],
8134281342
"bodyParameters": [],
81343-
"descriptionHTML": "<p>Gets a single secret scanning alert detected in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
81343+
"descriptionHTML": "<p>Gets a single secret scanning alert detected in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
8134481344
"responses": [
8134581345
{
8134681346
"httpStatusCode": "200",
@@ -81468,7 +81468,7 @@
8146881468
"slug": "update-a-secret-scanning-alert",
8146981469
"category": "secret-scanning",
8147081470
"notes": [],
81471-
"descriptionHTML": "<p>Updates the status of a secret scanning alert in a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> write permission to use this endpoint.</p>",
81471+
"descriptionHTML": "<p>Updates the status of a secret scanning alert in an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> write permission to use this endpoint.</p>",
8147281472
"bodyParameters": [
8147381473
{
8147481474
"description": "<p><strong>Required</strong>. Sets the state of the secret scanning alert. Can be either <code>open</code> or <code>resolved</code>. You must provide <code>resolution</code> when you set the state to <code>resolved</code>.</p>",
@@ -81601,7 +81601,7 @@
8160181601
"category": "secret-scanning",
8160281602
"notes": [],
8160381603
"bodyParameters": [],
81604-
"descriptionHTML": "<p>Lists all locations for a given secret scanning alert for a private repository. To use this endpoint, you must be an administrator for the repository or organization, and you must use an access token with the <code>repo</code> scope or <code>security_events</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
81604+
"descriptionHTML": "<p>Lists all locations for a given secret scanning alert for an eligible repository.\nTo use this endpoint, you must be an administrator for the repository or for the organization that owns the repository, and you must use a personal access token with the <code>repo</code> scope or <code>security_events</code> scope.\nFor public repositories, you may instead use the <code>public_repo</code> scope.</p>\n<p>GitHub Apps must have the <code>secret_scanning_alerts</code> read permission to use this endpoint.</p>",
8160581605
"responses": [
8160681606
{
8160781607
"httpStatusCode": "200",

lib/rest/static/decorated/ghes-3.1.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66019,12 +66019,12 @@
6601966019
{
6602066020
"name": "secret_type",
6602166021
"in": "query",
66022-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
66022+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
6602366023
"required": false,
6602466024
"schema": {
6602566025
"type": "string"
6602666026
},
66027-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
66027+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
6602866028
},
6602966029
{
6603066030
"name": "resolution",

lib/rest/static/decorated/ghes-3.2.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -68239,12 +68239,12 @@
6823968239
{
6824068240
"name": "secret_type",
6824168241
"in": "query",
68242-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
68242+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
6824368243
"required": false,
6824468244
"schema": {
6824568245
"type": "string"
6824668246
},
68247-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
68247+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
6824868248
},
6824968249
{
6825068250
"name": "resolution",

lib/rest/static/decorated/ghes-3.3.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68420,12 +68420,12 @@
6842068420
{
6842168421
"name": "secret_type",
6842268422
"in": "query",
68423-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
68423+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
6842468424
"required": false,
6842568425
"schema": {
6842668426
"type": "string"
6842768427
},
68428-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
68428+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
6842968429
},
6843068430
{
6843168431
"name": "resolution",
@@ -68538,12 +68538,12 @@
6853868538
{
6853968539
"name": "secret_type",
6854068540
"in": "query",
68541-
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[About secret scanning for private repositories](https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories)\"\nfor a complete list of secret types (API slug).",
68541+
"description": "A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"[Secret scanning patterns](https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)\"\nfor a complete list of secret types (API slug).",
6854268542
"required": false,
6854368543
"schema": {
6854468544
"type": "string"
6854568545
},
68546-
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-security/about-secret-scanning#about-secret-scanning-for-private-repositories\">About secret scanning for private repositories</a>\"\nfor a complete list of secret types (API slug).</p>"
68546+
"descriptionHTML": "<p>A comma-separated list of secret types to return. By default all secret types are returned.\nSee \"<a href=\"https://docs.github.com/[email protected]/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security\">Secret scanning patterns</a>\"\nfor a complete list of secret types (API slug).</p>"
6854768547
},
6854868548
{
6854968549
"name": "resolution",

0 commit comments

Comments
 (0)