Update OpenAPI Descriptions (#18984)
This commit is contained in:
committed by
GitHub
parent
993fe96d6c
commit
705ae14e9f
@@ -46895,7 +46895,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "Response",
|
||||
"payload": "<pre><code class=\"hljs language-json\">[\n {\n <span class=\"hljs-attr\">\"ref\"</span>: <span class=\"hljs-string\">\"refs/heads/main\"</span>,\n <span class=\"hljs-attr\">\"commit_sha\"</span>: <span class=\"hljs-string\">\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\"</span>,\n <span class=\"hljs-attr\">\"analysis_key\"</span>: <span class=\"hljs-string\">\".github/workflows/codeql-analysis.yml:analyze\"</span>,\n <span class=\"hljs-attr\">\"environment\"</span>: <span class=\"hljs-string\">\"{\\\"language\\\":\\\"python\\\"}\"</span>,\n <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2020-08-27T15:05:21Z\"</span>,\n <span class=\"hljs-attr\">\"results_count\"</span>: <span class=\"hljs-number\">17</span>,\n <span class=\"hljs-attr\">\"rules_count\"</span>: <span class=\"hljs-number\">49</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">201</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\"</span>,\n <span class=\"hljs-attr\">\"sarif_id\"</span>: <span class=\"hljs-string\">\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\"</span>,\n <span class=\"hljs-attr\">\"tool\"</span>: {\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"CodeQL\"</span>,\n <span class=\"hljs-attr\">\"guid\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"version\"</span>: <span class=\"hljs-string\">\"2.4.0\"</span>\n },\n <span class=\"hljs-attr\">\"deletable\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"warning\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n {\n <span class=\"hljs-attr\">\"ref\"</span>: <span class=\"hljs-string\">\"refs/heads/my-branch\"</span>,\n <span class=\"hljs-attr\">\"commit_sha\"</span>: <span class=\"hljs-string\">\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\"</span>,\n <span class=\"hljs-attr\">\"analysis_key\"</span>: <span class=\"hljs-string\">\".github/workflows/shiftleft.yml:build\"</span>,\n <span class=\"hljs-attr\">\"environment\"</span>: <span class=\"hljs-string\">\"{}\"</span>,\n <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2020-08-31T22:46:44Z\"</span>,\n <span class=\"hljs-attr\">\"results_count\"</span>: <span class=\"hljs-number\">17</span>,\n <span class=\"hljs-attr\">\"rules_count\"</span>: <span class=\"hljs-number\">32</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">200</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\"</span>,\n <span class=\"hljs-attr\">\"sarif_id\"</span>: <span class=\"hljs-string\">\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\"</span>,\n <span class=\"hljs-attr\">\"tool\"</span>: {\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"Python Security Analysis\"</span>,\n <span class=\"hljs-attr\">\"guid\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"version\"</span>: <span class=\"hljs-string\">\"1.2.0\"</span>\n },\n <span class=\"hljs-attr\">\"deletable\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"warning\"</span>: <span class=\"hljs-string\">\"\"</span>\n }\n]\n</code></pre>"
|
||||
"payload": "<pre><code class=\"hljs language-json\">[\n {\n <span class=\"hljs-attr\">\"ref\"</span>: <span class=\"hljs-string\">\"refs/heads/main\"</span>,\n <span class=\"hljs-attr\">\"commit_sha\"</span>: <span class=\"hljs-string\">\"d99612c3e1f2970085cfbaeadf8f010ef69bad83\"</span>,\n <span class=\"hljs-attr\">\"analysis_key\"</span>: <span class=\"hljs-string\">\".github/workflows/codeql-analysis.yml:analyze\"</span>,\n <span class=\"hljs-attr\">\"environment\"</span>: <span class=\"hljs-string\">\"{\\\"language\\\":\\\"python\\\"}\"</span>,\n <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"category\"</span>: <span class=\"hljs-string\">\".github/workflows/codeql-analysis.yml:analyze/language:python\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2020-08-27T15:05:21Z\"</span>,\n <span class=\"hljs-attr\">\"results_count\"</span>: <span class=\"hljs-number\">17</span>,\n <span class=\"hljs-attr\">\"rules_count\"</span>: <span class=\"hljs-number\">49</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">201</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\"</span>,\n <span class=\"hljs-attr\">\"sarif_id\"</span>: <span class=\"hljs-string\">\"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\"</span>,\n <span class=\"hljs-attr\">\"tool\"</span>: {\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"CodeQL\"</span>,\n <span class=\"hljs-attr\">\"guid\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"version\"</span>: <span class=\"hljs-string\">\"2.4.0\"</span>\n },\n <span class=\"hljs-attr\">\"deletable\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"warning\"</span>: <span class=\"hljs-string\">\"\"</span>\n },\n {\n <span class=\"hljs-attr\">\"ref\"</span>: <span class=\"hljs-string\">\"refs/heads/my-branch\"</span>,\n <span class=\"hljs-attr\">\"commit_sha\"</span>: <span class=\"hljs-string\">\"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\"</span>,\n <span class=\"hljs-attr\">\"analysis_key\"</span>: <span class=\"hljs-string\">\".github/workflows/shiftleft.yml:build\"</span>,\n <span class=\"hljs-attr\">\"environment\"</span>: <span class=\"hljs-string\">\"{}\"</span>,\n <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"category\"</span>: <span class=\"hljs-string\">\".github/workflows/shiftleft.yml:build/\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2020-08-31T22:46:44Z\"</span>,\n <span class=\"hljs-attr\">\"results_count\"</span>: <span class=\"hljs-number\">17</span>,\n <span class=\"hljs-attr\">\"rules_count\"</span>: <span class=\"hljs-number\">32</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">200</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\"</span>,\n <span class=\"hljs-attr\">\"sarif_id\"</span>: <span class=\"hljs-string\">\"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\"</span>,\n <span class=\"hljs-attr\">\"tool\"</span>: {\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"Python Security Analysis\"</span>,\n <span class=\"hljs-attr\">\"guid\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"version\"</span>: <span class=\"hljs-string\">\"1.2.0\"</span>\n },\n <span class=\"hljs-attr\">\"deletable\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"warning\"</span>: <span class=\"hljs-string\">\"\"</span>\n }\n]\n</code></pre>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
@@ -46987,7 +46987,7 @@
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "Default response",
|
||||
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"ref\"</span>: <span class=\"hljs-string\">\"refs/heads/main\"</span>,\n <span class=\"hljs-attr\">\"commit_sha\"</span>: <span class=\"hljs-string\">\"c18c69115654ff0166991962832dc2bd7756e655\"</span>,\n <span class=\"hljs-attr\">\"analysis_key\"</span>: <span class=\"hljs-string\">\".github/workflows/codeql-analysis.yml:analyze\"</span>,\n <span class=\"hljs-attr\">\"environment\"</span>: <span class=\"hljs-string\">\"{\\\"language\\\":\\\"javascript\\\"}\"</span>,\n <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2021-01-13T11:55:49Z\"</span>,\n <span class=\"hljs-attr\">\"results_count\"</span>: <span class=\"hljs-number\">3</span>,\n <span class=\"hljs-attr\">\"rules_count\"</span>: <span class=\"hljs-number\">67</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">3602840</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\"</span>,\n <span class=\"hljs-attr\">\"sarif_id\"</span>: <span class=\"hljs-string\">\"47177e22-5596-11eb-80a1-c1e54ef945c6\"</span>,\n <span class=\"hljs-attr\">\"tool\"</span>: {\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"CodeQL\"</span>,\n <span class=\"hljs-attr\">\"guid\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"version\"</span>: <span class=\"hljs-string\">\"2.4.0\"</span>\n },\n <span class=\"hljs-attr\">\"deletable\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"warning\"</span>: <span class=\"hljs-string\">\"\"</span>\n}\n</code></pre>"
|
||||
"payload": "<pre><code class=\"hljs language-json\">{\n <span class=\"hljs-attr\">\"ref\"</span>: <span class=\"hljs-string\">\"refs/heads/main\"</span>,\n <span class=\"hljs-attr\">\"commit_sha\"</span>: <span class=\"hljs-string\">\"c18c69115654ff0166991962832dc2bd7756e655\"</span>,\n <span class=\"hljs-attr\">\"analysis_key\"</span>: <span class=\"hljs-string\">\".github/workflows/codeql-analysis.yml:analyze\"</span>,\n <span class=\"hljs-attr\">\"environment\"</span>: <span class=\"hljs-string\">\"{\\\"language\\\":\\\"javascript\\\"}\"</span>,\n <span class=\"hljs-attr\">\"error\"</span>: <span class=\"hljs-string\">\"\"</span>,\n <span class=\"hljs-attr\">\"category\"</span>: <span class=\"hljs-string\">\".github/workflows/codeql-analysis.yml:analyze/language:javascript\"</span>,\n <span class=\"hljs-attr\">\"created_at\"</span>: <span class=\"hljs-string\">\"2021-01-13T11:55:49Z\"</span>,\n <span class=\"hljs-attr\">\"results_count\"</span>: <span class=\"hljs-number\">3</span>,\n <span class=\"hljs-attr\">\"rules_count\"</span>: <span class=\"hljs-number\">67</span>,\n <span class=\"hljs-attr\">\"id\"</span>: <span class=\"hljs-number\">3602840</span>,\n <span class=\"hljs-attr\">\"url\"</span>: <span class=\"hljs-string\">\"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\"</span>,\n <span class=\"hljs-attr\">\"sarif_id\"</span>: <span class=\"hljs-string\">\"47177e22-5596-11eb-80a1-c1e54ef945c6\"</span>,\n <span class=\"hljs-attr\">\"tool\"</span>: {\n <span class=\"hljs-attr\">\"name\"</span>: <span class=\"hljs-string\">\"CodeQL\"</span>,\n <span class=\"hljs-attr\">\"guid\"</span>: <span class=\"hljs-literal\">null</span>,\n <span class=\"hljs-attr\">\"version\"</span>: <span class=\"hljs-string\">\"2.4.0\"</span>\n },\n <span class=\"hljs-attr\">\"deletable\"</span>: <span class=\"hljs-literal\">true</span>,\n <span class=\"hljs-attr\">\"warning\"</span>: <span class=\"hljs-string\">\"\"</span>\n}\n</code></pre>"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "403",
|
||||
@@ -47310,11 +47310,6 @@
|
||||
}
|
||||
],
|
||||
"responses": [
|
||||
{
|
||||
"httpStatusCode": "200",
|
||||
"httpStatusMessage": "OK",
|
||||
"description": "Response"
|
||||
},
|
||||
{
|
||||
"httpStatusCode": "202",
|
||||
"httpStatusMessage": "Accepted",
|
||||
|
||||
Reference in New Issue
Block a user