From 9ca7c4146686d0698c66607498481b3b866749d1 Mon Sep 17 00:00:00 2001 From: github-openapi-bot <69533958+github-openapi-bot@users.noreply.github.com> Date: Tue, 5 Oct 2021 09:07:26 -0400 Subject: [PATCH] Update OpenAPI Descriptions (#21889) * Update OpenAPI Descriptions --- lib/rest/static/decorated/api.github.com.json | 50 +++++-------------- lib/rest/static/decorated/ghes-2.22.json | 18 +++---- lib/rest/static/decorated/ghes-3.0.json | 20 ++++---- lib/rest/static/decorated/ghes-3.1.json | 20 ++++---- lib/rest/static/decorated/ghes-3.2.json | 20 ++++---- lib/rest/static/decorated/github.ae.json | 50 +++++-------------- .../dereferenced/api.github.com.deref.json | 30 +---------- .../static/dereferenced/ghes-2.22.deref.json | 30 +++++------ .../static/dereferenced/ghes-3.0.deref.json | 33 ++++++------ .../static/dereferenced/ghes-3.1.deref.json | 33 ++++++------ .../static/dereferenced/ghes-3.2.deref.json | 33 ++++++------ .../static/dereferenced/github.ae.deref.json | 30 +---------- 12 files changed, 130 insertions(+), 237 deletions(-) diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index 0353f23048..40b0db3a37 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -39556,13 +39556,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  mediaType: {\n    previews: [\n      'zzzax'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], "summary": "Get commit signature protection", @@ -39578,14 +39578,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", - "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" - } - ], "category": "repos", "subcategory": "branches" }, @@ -39649,13 +39641,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  mediaType: {\n    previews: [\n      'zzzax'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], "summary": "Create commit signature protection", @@ -39671,14 +39663,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", - "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" - } - ], "category": "repos", "subcategory": "branches" }, @@ -39742,13 +39726,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  mediaType: {\n    previews: [\n      'zzzax'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], "summary": "Delete commit signature protection", @@ -39764,14 +39748,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", - "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" - } - ], "category": "repos", "subcategory": "branches" }, @@ -47647,7 +47623,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\n  \"instances\": null\n}\n
" + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" }, { "httpStatusCode": "403", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 22468ae972..0cdf188188 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -33521,6 +33521,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -33528,9 +33530,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "get-commit-signature-protection", "category": "repos", @@ -33614,6 +33614,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -33621,9 +33623,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "create-commit-signature-protection", "category": "repos", @@ -33707,6 +33707,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -33714,9 +33716,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "delete-commit-signature-protection", "category": "repos", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index f4f6a4534f..44c11299fc 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -38127,6 +38127,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -38134,9 +38136,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "get-commit-signature-protection", "category": "repos", @@ -38220,6 +38220,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -38227,9 +38229,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "create-commit-signature-protection", "category": "repos", @@ -38313,6 +38313,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -38320,9 +38322,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "delete-commit-signature-protection", "category": "repos", @@ -46063,7 +46063,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\n  \"instances\": null\n}\n
" + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" }, { "httpStatusCode": "403", diff --git a/lib/rest/static/decorated/ghes-3.1.json b/lib/rest/static/decorated/ghes-3.1.json index 25ea79487f..a2e4c4cdee 100644 --- a/lib/rest/static/decorated/ghes-3.1.json +++ b/lib/rest/static/decorated/ghes-3.1.json @@ -38265,6 +38265,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -38272,9 +38274,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "get-commit-signature-protection", "category": "repos", @@ -38358,6 +38358,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -38365,9 +38367,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "create-commit-signature-protection", "category": "repos", @@ -38451,6 +38451,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -38458,9 +38460,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "delete-commit-signature-protection", "category": "repos", @@ -46334,7 +46334,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\n  \"instances\": null\n}\n
" + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" }, { "httpStatusCode": "403", diff --git a/lib/rest/static/decorated/ghes-3.2.json b/lib/rest/static/decorated/ghes-3.2.json index 25e9195104..6acfe2d5f9 100644 --- a/lib/rest/static/decorated/ghes-3.2.json +++ b/lib/rest/static/decorated/ghes-3.2.json @@ -39536,6 +39536,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -39543,9 +39545,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "get-commit-signature-protection", "category": "repos", @@ -39629,6 +39629,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -39636,9 +39638,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "create-commit-signature-protection", "category": "repos", @@ -39722,6 +39722,8 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, @@ -39729,9 +39731,7 @@ "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```", "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" } - ], - "category": "repos", - "subcategory": "branches" + ] }, "slug": "delete-commit-signature-protection", "category": "repos", @@ -47605,7 +47605,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\n  \"instances\": null\n}\n
" + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" }, { "httpStatusCode": "403", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index 7a3259a3ea..56ea9542d0 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -31476,13 +31476,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  mediaType: {\n    previews: [\n      'zzzax'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], "summary": "Get commit signature protection", @@ -31498,14 +31498,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", - "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" - } - ], "category": "repos", "subcategory": "branches" }, @@ -31569,13 +31561,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  mediaType: {\n    previews: [\n      'zzzax'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], "summary": "Create commit signature protection", @@ -31591,14 +31583,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", - "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" - } - ], "category": "repos", "subcategory": "branches" }, @@ -31662,13 +31646,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.zzzax-preview+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://{hostname}/api/v3/repos/octocat/hello-world/branches/BRANCH/protection/required_signatures
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch',\n mediaType: {\n previews: [\n 'zzzax'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch',\n  mediaType: {\n    previews: [\n      'zzzax'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n owner: 'octocat',\n repo: 'hello-world',\n branch: 'branch'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/branches/{branch}/protection/required_signatures', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  branch: 'branch'\n})\n
" } ], "summary": "Delete commit signature protection", @@ -31684,14 +31668,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```", - "html": "

Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.zzzax-preview+json
" - } - ], "category": "repos", "subcategory": "branches" }, @@ -39434,7 +39410,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Response", - "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\",\n  \"instances\": null\n}\n
" + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"security_severity_level\": \"high\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" }, { "httpStatusCode": "403", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index 27f8b0882e..96d3a4b326 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -155575,13 +155575,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" - } - ], "category": "repos", "subcategory": "branches" } @@ -155691,13 +155684,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" - } - ], "category": "repos", "subcategory": "branches" } @@ -155775,13 +155761,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" - } - ], "category": "repos", "subcategory": "branches" } @@ -178262,9 +178241,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -178661,8 +178637,7 @@ "test" ] }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances", - "instances": null + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } } } @@ -178867,9 +178842,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index fd9a416818..f922a13c3b 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -128804,15 +128804,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "post": { @@ -128920,15 +128920,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "delete": { @@ -129004,15 +129004,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } } }, @@ -149913,9 +149913,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "state": { "type": "string", "description": "State of a code scanning alert.", @@ -150128,6 +150125,9 @@ "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } + }, + "instances": { + "deprecated": true } }, "required": [ @@ -150437,9 +150437,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "state": { "type": "string", "description": "State of a code scanning alert.", @@ -150652,6 +150649,9 @@ "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } } + }, + "instances": { + "deprecated": true } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index c02f0baf82..7a10b2c513 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -135055,15 +135055,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "post": { @@ -135171,15 +135171,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "delete": { @@ -135255,15 +135255,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } } }, @@ -156126,9 +156126,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -156429,6 +156426,9 @@ } } } + }, + "instances": { + "deprecated": true } }, "required": [ @@ -156514,8 +156514,7 @@ "test" ] }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances", - "instances": null + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } } } @@ -156720,9 +156719,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -157023,6 +157019,9 @@ } } } + }, + "instances": { + "deprecated": true } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.1.deref.json b/lib/rest/static/dereferenced/ghes-3.1.deref.json index 885f50a2e9..e2fa667c1e 100644 --- a/lib/rest/static/dereferenced/ghes-3.1.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.1.deref.json @@ -135375,15 +135375,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "post": { @@ -135491,15 +135491,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "delete": { @@ -135575,15 +135575,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.1/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } } }, @@ -158014,9 +158014,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -158317,6 +158314,9 @@ } } } + }, + "instances": { + "deprecated": true } }, "required": [ @@ -158402,8 +158402,7 @@ "test" ] }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances", - "instances": null + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } } } @@ -158608,9 +158607,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -158911,6 +158907,9 @@ } } } + }, + "instances": { + "deprecated": true } }, "required": [ diff --git a/lib/rest/static/dereferenced/ghes-3.2.deref.json b/lib/rest/static/dereferenced/ghes-3.2.deref.json index 732972e77f..7cdd021d57 100644 --- a/lib/rest/static/dereferenced/ghes-3.2.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.2.deref.json @@ -139036,15 +139036,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "post": { @@ -139152,15 +139152,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } }, "delete": { @@ -139236,15 +139236,15 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, + "category": "repos", + "subcategory": "branches", "previews": [ { "required": true, "name": "zzzax", "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.2/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.zzzax-preview+json\n```" } - ], - "category": "repos", - "subcategory": "branches" + ] } } }, @@ -161723,9 +161723,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -162037,6 +162034,9 @@ } } } + }, + "instances": { + "deprecated": true } }, "required": [ @@ -162122,8 +162122,7 @@ "test" ] }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances", - "instances": null + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } } } @@ -162328,9 +162327,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -162642,6 +162638,9 @@ } } } + }, + "instances": { + "deprecated": true } }, "required": [ diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index fb20edac9a..35b62f481c 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -109724,13 +109724,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" - } - ], "category": "repos", "subcategory": "branches" } @@ -109840,13 +109833,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" - } - ], "category": "repos", "subcategory": "branches" } @@ -109924,13 +109910,6 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "zzzax", - "note": "Protected Branches API can now manage a setting for requiring signed commits. This feature is currently available for developers to preview. See the [blog post](https://developer.github.com/changes/2018-02-22-protected-branches-required-signatures) for full details. To access the API 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.zzzax-preview+json\n```" - } - ], "category": "repos", "subcategory": "branches" } @@ -130843,9 +130822,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.", @@ -131242,8 +131218,7 @@ "test" ] }, - "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances", - "instances": null + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" } } } @@ -131448,9 +131423,6 @@ "readOnly": true, "nullable": false }, - "instances": { - "deprecated": true - }, "instances_url": { "type": "string", "description": "The REST API URL for fetching the list of instances for an alert.",