Skip to content

Commit 4cb8771

Browse files
github-openapi-botgithub-openapi-bot
authored
Update OpenAPI Descriptions (#19128)
1 parent db22bf0 commit 4cb8771

14 files changed

+0
-1722
lines changed

‎lib/rest/static/decorated/ghes-2.18.json

Lines changed: 0 additions & 148 deletions
Original file line numberDiff line numberDiff line change
@@ -53566,154 +53566,6 @@
5356653566
}
5356753567
]
5356853568
},
53569-
{
53570-
"verb": "put",
53571-
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
53572-
"serverUrl": "http(s)://{hostname}/api/v3",
53573-
"parameters": [
53574-
{
53575-
"name": "owner",
53576-
"in": "path",
53577-
"required": true,
53578-
"schema": {
53579-
"type": "string"
53580-
},
53581-
"descriptionHTML": ""
53582-
},
53583-
{
53584-
"name": "repo",
53585-
"in": "path",
53586-
"required": true,
53587-
"schema": {
53588-
"type": "string"
53589-
},
53590-
"descriptionHTML": ""
53591-
}
53592-
],
53593-
"x-codeSamples": [
53594-
{
53595-
"lang": "Shell",
53596-
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts",
53597-
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts</code></pre>"
53598-
},
53599-
{
53600-
"lang": "JavaScript",
53601-
"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})",
53602-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/vulnerability-alerts'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'dorian'</span>\n ]\n }\n})\n</code></pre>"
53603-
}
53604-
],
53605-
"summary": "Enable vulnerability alerts",
53606-
"description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
53607-
"tags": [
53608-
"repos"
53609-
],
53610-
"operationId": "repos/enable-vulnerability-alerts",
53611-
"externalDocs": {
53612-
"description": "API method documentation",
53613-
"url": "https://docs.github.com/[email protected]/rest/reference/repos#enable-vulnerability-alerts"
53614-
},
53615-
"x-github": {
53616-
"githubCloudOnly": false,
53617-
"enabledForGitHubApps": true,
53618-
"previews": [
53619-
{
53620-
"required": true,
53621-
"name": "dorian",
53622-
"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/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
53623-
"html": "<p>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 <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.dorian-preview+json</code></pre>"
53624-
}
53625-
],
53626-
"category": "repos",
53627-
"subcategory": null
53628-
},
53629-
"slug": "enable-vulnerability-alerts",
53630-
"category": "repos",
53631-
"categoryLabel": "Repos",
53632-
"notes": [],
53633-
"responses": [
53634-
{
53635-
"httpStatusCode": "204",
53636-
"httpStatusMessage": "No Content",
53637-
"description": "Response"
53638-
}
53639-
],
53640-
"bodyParameters": [],
53641-
"descriptionHTML": "<p>Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies\">About security alerts for vulnerable dependencies</a>\".</p>"
53642-
},
53643-
{
53644-
"verb": "delete",
53645-
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
53646-
"serverUrl": "http(s)://{hostname}/api/v3",
53647-
"parameters": [
53648-
{
53649-
"name": "owner",
53650-
"in": "path",
53651-
"required": true,
53652-
"schema": {
53653-
"type": "string"
53654-
},
53655-
"descriptionHTML": ""
53656-
},
53657-
{
53658-
"name": "repo",
53659-
"in": "path",
53660-
"required": true,
53661-
"schema": {
53662-
"type": "string"
53663-
},
53664-
"descriptionHTML": ""
53665-
}
53666-
],
53667-
"x-codeSamples": [
53668-
{
53669-
"lang": "Shell",
53670-
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts",
53671-
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts</code></pre>"
53672-
},
53673-
{
53674-
"lang": "JavaScript",
53675-
"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})",
53676-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/vulnerability-alerts'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'dorian'</span>\n ]\n }\n})\n</code></pre>"
53677-
}
53678-
],
53679-
"summary": "Disable vulnerability alerts",
53680-
"description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
53681-
"tags": [
53682-
"repos"
53683-
],
53684-
"operationId": "repos/disable-vulnerability-alerts",
53685-
"externalDocs": {
53686-
"description": "API method documentation",
53687-
"url": "https://docs.github.com/[email protected]/rest/reference/repos#disable-vulnerability-alerts"
53688-
},
53689-
"x-github": {
53690-
"githubCloudOnly": false,
53691-
"enabledForGitHubApps": true,
53692-
"previews": [
53693-
{
53694-
"required": true,
53695-
"name": "dorian",
53696-
"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/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
53697-
"html": "<p>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 <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.dorian-preview+json</code></pre>"
53698-
}
53699-
],
53700-
"category": "repos",
53701-
"subcategory": null
53702-
},
53703-
"slug": "disable-vulnerability-alerts",
53704-
"category": "repos",
53705-
"categoryLabel": "Repos",
53706-
"notes": [],
53707-
"responses": [
53708-
{
53709-
"httpStatusCode": "204",
53710-
"httpStatusMessage": "No Content",
53711-
"description": "Response"
53712-
}
53713-
],
53714-
"bodyParameters": [],
53715-
"descriptionHTML": "<p>Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies\">About security alerts for vulnerable dependencies</a>\".</p>"
53716-
},
5371753569
{
5371853570
"verb": "get",
5371953571
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

‎lib/rest/static/decorated/ghes-2.19.json

Lines changed: 0 additions & 148 deletions
Original file line numberDiff line numberDiff line change
@@ -54398,154 +54398,6 @@
5439854398
}
5439954399
]
5440054400
},
54401-
{
54402-
"verb": "put",
54403-
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
54404-
"serverUrl": "http(s)://{hostname}/api/v3",
54405-
"parameters": [
54406-
{
54407-
"name": "owner",
54408-
"in": "path",
54409-
"required": true,
54410-
"schema": {
54411-
"type": "string"
54412-
},
54413-
"descriptionHTML": ""
54414-
},
54415-
{
54416-
"name": "repo",
54417-
"in": "path",
54418-
"required": true,
54419-
"schema": {
54420-
"type": "string"
54421-
},
54422-
"descriptionHTML": ""
54423-
}
54424-
],
54425-
"x-codeSamples": [
54426-
{
54427-
"lang": "Shell",
54428-
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts",
54429-
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts</code></pre>"
54430-
},
54431-
{
54432-
"lang": "JavaScript",
54433-
"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})",
54434-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'PUT /repos/{owner}/{repo}/vulnerability-alerts'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'dorian'</span>\n ]\n }\n})\n</code></pre>"
54435-
}
54436-
],
54437-
"summary": "Enable vulnerability alerts",
54438-
"description": "Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
54439-
"tags": [
54440-
"repos"
54441-
],
54442-
"operationId": "repos/enable-vulnerability-alerts",
54443-
"externalDocs": {
54444-
"description": "API method documentation",
54445-
"url": "https://docs.github.com/[email protected]/rest/reference/repos#enable-vulnerability-alerts"
54446-
},
54447-
"x-github": {
54448-
"githubCloudOnly": false,
54449-
"enabledForGitHubApps": true,
54450-
"previews": [
54451-
{
54452-
"required": true,
54453-
"name": "dorian",
54454-
"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/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
54455-
"html": "<p>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 <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.dorian-preview+json</code></pre>"
54456-
}
54457-
],
54458-
"category": "repos",
54459-
"subcategory": null
54460-
},
54461-
"slug": "enable-vulnerability-alerts",
54462-
"category": "repos",
54463-
"categoryLabel": "Repos",
54464-
"notes": [],
54465-
"responses": [
54466-
{
54467-
"httpStatusCode": "204",
54468-
"httpStatusMessage": "No Content",
54469-
"description": "Response"
54470-
}
54471-
],
54472-
"bodyParameters": [],
54473-
"descriptionHTML": "<p>Enables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies\">About security alerts for vulnerable dependencies</a>\".</p>"
54474-
},
54475-
{
54476-
"verb": "delete",
54477-
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
54478-
"serverUrl": "http(s)://{hostname}/api/v3",
54479-
"parameters": [
54480-
{
54481-
"name": "owner",
54482-
"in": "path",
54483-
"required": true,
54484-
"schema": {
54485-
"type": "string"
54486-
},
54487-
"descriptionHTML": ""
54488-
},
54489-
{
54490-
"name": "repo",
54491-
"in": "path",
54492-
"required": true,
54493-
"schema": {
54494-
"type": "string"
54495-
},
54496-
"descriptionHTML": ""
54497-
}
54498-
],
54499-
"x-codeSamples": [
54500-
{
54501-
"lang": "Shell",
54502-
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts",
54503-
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://{hostname}/api/v3/repos/octocat/hello-world/vulnerability-alerts</code></pre>"
54504-
},
54505-
{
54506-
"lang": "JavaScript",
54507-
"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})",
54508-
"html": "<pre><code class=\"hljs language-javascript\"><span class=\"hljs-keyword\">await</span> octokit.request(<span class=\"hljs-string\">'DELETE /repos/{owner}/{repo}/vulnerability-alerts'</span>, {\n <span class=\"hljs-attr\">owner</span>: <span class=\"hljs-string\">'octocat'</span>,\n <span class=\"hljs-attr\">repo</span>: <span class=\"hljs-string\">'hello-world'</span>,\n <span class=\"hljs-attr\">mediaType</span>: {\n <span class=\"hljs-attr\">previews</span>: [\n <span class=\"hljs-string\">'dorian'</span>\n ]\n }\n})\n</code></pre>"
54509-
}
54510-
],
54511-
"summary": "Disable vulnerability alerts",
54512-
"description": "Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"[About security alerts for vulnerable dependencies](https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies)\".",
54513-
"tags": [
54514-
"repos"
54515-
],
54516-
"operationId": "repos/disable-vulnerability-alerts",
54517-
"externalDocs": {
54518-
"description": "API method documentation",
54519-
"url": "https://docs.github.com/[email protected]/rest/reference/repos#disable-vulnerability-alerts"
54520-
},
54521-
"x-github": {
54522-
"githubCloudOnly": false,
54523-
"enabledForGitHubApps": true,
54524-
"previews": [
54525-
{
54526-
"required": true,
54527-
"name": "dorian",
54528-
"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/[email protected]/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
54529-
"html": "<p>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 <a href=\"https://docs.github.com/[email protected]/rest/overview/media-types\">media type</a> in the <code>Accept</code> header:</p>\n<pre><code class=\"hljs language-shell\">application/vnd.github.dorian-preview+json</code></pre>"
54530-
}
54531-
],
54532-
"category": "repos",
54533-
"subcategory": null
54534-
},
54535-
"slug": "disable-vulnerability-alerts",
54536-
"category": "repos",
54537-
"categoryLabel": "Repos",
54538-
"notes": [],
54539-
"responses": [
54540-
{
54541-
"httpStatusCode": "204",
54542-
"httpStatusMessage": "No Content",
54543-
"description": "Response"
54544-
}
54545-
],
54546-
"bodyParameters": [],
54547-
"descriptionHTML": "<p>Disables dependency alerts and the dependency graph for a repository. The authenticated user must have admin access to the repository. For more information, see \"<a href=\"https://help.github.com/en/articles/about-security-alerts-for-vulnerable-dependencies\">About security alerts for vulnerable dependencies</a>\".</p>"
54548-
},
5454954401
{
5455054402
"verb": "get",
5455154403
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

0 commit comments

Comments
 (0)