From f9098518bc42061808189483cae55eb8a0dadb9d Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Thu, 23 Sep 2021 02:08:44 -0400 Subject: [PATCH] Update OpenAPI Descriptions (#21670) --- lib/rest/static/decorated/api.github.com.json | 48 ++++------------ .../dereferenced/api.github.com.deref.json | 55 ++++++++++++------- .../static/dereferenced/ghes-2.18.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-2.19.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-2.20.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-2.21.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-2.22.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-3.0.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-3.1.deref.json | 34 ++++++++++++ .../static/dereferenced/ghes-3.2.deref.json | 34 ++++++++++++ .../static/dereferenced/github.ae.deref.json | 34 ++++++++++++ 11 files changed, 352 insertions(+), 57 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index d6f327969f..3b43a52668 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -78011,13 +78011,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/vulnerability-alerts', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  mediaType: {\n    previews: [\n      'dorian'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/vulnerability-alerts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], "summary": "Check if vulnerability alerts are enabled for a repository", @@ -78033,14 +78033,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "dorian", - "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```", - "html": "

Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.dorian-preview+json
" - } - ], "category": "repos", "subcategory": null }, @@ -78090,13 +78082,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})", - "html": "
await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  mediaType: {\n    previews: [\n      'dorian'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/vulnerability-alerts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], "summary": "Enable vulnerability alerts", @@ -78112,14 +78104,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "dorian", - "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```", - "html": "

Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.dorian-preview+json
" - } - ], "category": "repos", "subcategory": null }, @@ -78164,13 +78148,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/vulnerability-alerts", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/vulnerability-alerts
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world',\n mediaType: {\n previews: [\n 'dorian'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  mediaType: {\n    previews: [\n      'dorian'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/vulnerability-alerts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], "summary": "Disable vulnerability alerts", @@ -78186,14 +78170,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "dorian", - "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```", - "html": "

Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.dorian-preview+json
" - } - ], "category": "repos", "subcategory": null }, diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index d5bb18c53d..5d0f6efcff 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -284940,6 +284940,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -285204,6 +285221,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -334224,13 +334258,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "dorian", - "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```" - } - ], "category": "repos", "subcategory": null } @@ -334272,13 +334299,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "dorian", - "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```" - } - ], "category": "repos", "subcategory": null } @@ -334320,13 +334340,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "dorian", - "note": "Enabling and disabling dependency alerts for a repository using the REST API is currently available for developers to preview. To access these new endpoints during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```" - } - ], "category": "repos", "subcategory": null } diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 87fdaa1c3d..7062198e38 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -202062,6 +202062,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -202330,6 +202347,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index d8b3463787..edbef1dd60 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -205735,6 +205735,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -206003,6 +206020,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 2b96a499d3..be78458320 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -208194,6 +208194,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -208462,6 +208479,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index e3338459f6..f0d416dfb2 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -220633,6 +220633,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -220901,6 +220918,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index 70951ee2df..da6e6c5308 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -252436,6 +252436,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -252700,6 +252717,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index acfb40e428..2d7d246494 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -259268,6 +259268,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -259532,6 +259549,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index cb6d5a0f78..c287dc694c 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -262240,6 +262240,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -262504,6 +262521,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 0e3eb746f1..88b3fd6f95 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -269061,6 +269061,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -269325,6 +269342,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 590b66e7ad..a3a4c83f4c 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -233271,6 +233271,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.", @@ -233535,6 +233552,23 @@ "type": "string", "nullable": true }, + "protected_domain_state": { + "type": "string", + "description": "The state if the domain is protected", + "example": "pending", + "nullable": true, + "enum": [ + "pending", + "verified", + "unverified" + ] + }, + "pending_domain_unverified_at": { + "type": "string", + "description": "The timestamp when a pending domain becomes unverified.", + "nullable": true, + "format": "date-time" + }, "custom_404": { "type": "boolean", "description": "Whether the Page has a custom 404 page.",