jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-25 02:17:36 -05:00
Code Issues Projects Releases Wiki Activity

Update OpenAPI Descriptions (#19128)

Browse Source
This commit is contained in:
github-openapi-bot
2021-05-04 11:44:41 -04:00
committed by GitHub
parent db22bf06f1
commit 4cb877151d
14 changed files with 0 additions and 1722 deletions
Download Patch File Download Diff File Expand all files Collapse all files

148
lib/rest/static/decorated/ghes-2.18.json
View File

@@ -53566,154 +53566,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#enable-vulnerability-alerts"
},
"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/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.18/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#disable-vulnerability-alerts"
},
"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/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.18/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

148
lib/rest/static/decorated/ghes-2.19.json
View File

@@ -54398,154 +54398,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#enable-vulnerability-alerts"
},
"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/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.19/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#disable-vulnerability-alerts"
},
"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/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.19/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

148
lib/rest/static/decorated/ghes-2.20.json
View File

@@ -55054,154 +55054,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#enable-vulnerability-alerts"
},
"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/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.20/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#disable-vulnerability-alerts"
},
"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/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.20/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

148
lib/rest/static/decorated/ghes-2.21.json
View File

@@ -59108,154 +59108,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#enable-vulnerability-alerts"
},
"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/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.21/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#disable-vulnerability-alerts"
},
"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/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.21/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

148
lib/rest/static/decorated/ghes-2.22.json
View File

@@ -66828,154 +66828,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#enable-vulnerability-alerts"
},
"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/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.22/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#disable-vulnerability-alerts"
},
"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/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@2.22/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

148
lib/rest/static/decorated/ghes-3.0.json
View File

@@ -71556,154 +71556,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#enable-vulnerability-alerts"
},
"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/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@3.0/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://{hostname}/api/v3",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"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",
"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>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#disable-vulnerability-alerts"
},
"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/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/enterprise-server@3.0/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

148
lib/rest/static/decorated/github.ae.json
View File

@@ -64749,154 +64749,6 @@
}
]
},
{
"verb": "put",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts</code></pre>"
},
{
"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": "<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>"
}
],
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#enable-vulnerability-alerts"
},
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/github-ae@latest/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "enable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "delete",
"requestPath": "/repos/{owner}/{repo}/vulnerability-alerts",
"serverUrl": "http(s)://api.{hostname}",
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
},
"descriptionHTML": ""
}
],
"x-codeSamples": [
{
"lang": "Shell",
"source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts",
"html": "<pre><code class=\"hljs language-shell\">curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.dorian-preview+json\" \\\n http(s)://api.{hostname}/repos/octocat/hello-world/vulnerability-alerts</code></pre>"
},
{
"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": "<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>"
}
],
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#disable-vulnerability-alerts"
},
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```",
"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/github-ae@latest/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>"
}
],
"category": "repos",
"subcategory": null
},
"slug": "disable-vulnerability-alerts",
"category": "repos",
"categoryLabel": "Repos",
"notes": [],
"responses": [
{
"httpStatusCode": "204",
"httpStatusMessage": "No Content",
"description": "Response"
}
],
"bodyParameters": [],
"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>"
},
{
"verb": "get",
"requestPath": "/repos/{owner}/{repo}/zipball/{ref}",

98
lib/rest/static/dereferenced/ghes-2.18.deref.json
View File

@@ -222293,104 +222293,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.18/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.18/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",

98
lib/rest/static/dereferenced/ghes-2.19.deref.json
View File

@@ -225778,104 +225778,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.19/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.19/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",

98
lib/rest/static/dereferenced/ghes-2.20.deref.json
View File

@@ -228852,104 +228852,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.20/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.20/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",

98
lib/rest/static/dereferenced/ghes-2.21.deref.json
View File

@@ -241142,104 +241142,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.21/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.21/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",

98
lib/rest/static/dereferenced/ghes-2.22.deref.json
View File

@@ -272297,104 +272297,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@2.22/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@2.22/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",

98
lib/rest/static/dereferenced/ghes-3.0.deref.json
View File

@@ -277833,104 +277833,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/enterprise-server@3.0/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/enterprise-server@3.0/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",

98
lib/rest/static/dereferenced/github.ae.deref.json
View File

@@ -258611,104 +258611,6 @@
}
}
},
"/repos/{owner}/{repo}/vulnerability-alerts": {
"put": {
"summary": "Enable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/enable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#enable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
},
"delete": {
"summary": "Disable vulnerability alerts",
"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)\".",
"tags": [
"repos"
],
"operationId": "repos/disable-vulnerability-alerts",
"externalDocs": {
"description": "API method documentation",
"url": "https://docs.github.com/github-ae@latest/rest/reference/repos#disable-vulnerability-alerts"
},
"parameters": [
{
"name": "owner",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "repo",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Response"
}
},
"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/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.dorian-preview+json\n```"
}
],
"category": "repos",
"subcategory": null
}
}
},
"/repos/{owner}/{repo}/zipball/{ref}": {
"get": {
"summary": "Download a repository archive (zip)",