diff --git a/docs/codeScanning/getAnalysis.md b/docs/codeScanning/getAnalysis.md index 6d43cff7d..c61ff2206 100644 --- a/docs/codeScanning/getAnalysis.md +++ b/docs/codeScanning/getAnalysis.md @@ -26,7 +26,6 @@ If you use the Accept header `application/sarif+json`, the response contains the analysis data that was uploaded. This is formatted as [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). -For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)." **Deprecation notice**: The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. diff --git a/package-lock.json b/package-lock.json index c8f6b9484..c59356770 100644 --- a/package-lock.json +++ b/package-lock.json @@ -2214,9 +2214,9 @@ } }, "@octokit/openapi-types": { - "version": "7.3.5", - "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.3.5.tgz", - "integrity": "sha512-6bm5lzGDOeSnWHM5W8OZ86RD2KpchynU+/Qlm5hNEFjfLDhwfAY2lSe68YRUEYFGlxSHe0HmakyhvmtWoD3Zog==" + "version": "7.4.0", + "resolved": "https://registry.npmjs.org/@octokit/openapi-types/-/openapi-types-7.4.0.tgz", + "integrity": "sha512-V2qNML1knHjrjTJcIIvhYZSTkvtSAoQpNEX8y0ykTJI8vOQPqIh0y6Jf9EU6c/y+v0c9+LeC1acwLQh1xo96MA==" }, "@octokit/plugin-paginate-rest": { "version": "2.13.5", @@ -2281,11 +2281,11 @@ } }, "@octokit/types": { - "version": "6.16.7", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.16.7.tgz", - "integrity": "sha512-OuQELiwIKeDySgNID52vm33wDRc2aaX8lKYgAw9Hmw939ITow1HspT8/AH3M3jgGFUMDmHlMNBNEmH7xV7ggXQ==", + "version": "6.17.1", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-6.17.1.tgz", + "integrity": "sha512-x1RDwjjSzGHK8hfwyNa4Gz0t5YtwUfIxEtejFpm2cjH1gMMk6XDv8La3gUAPzYpDgdzTEF8Lpz+7BGv9aZR/0w==", "requires": { - "@octokit/openapi-types": "^7.3.5" + "@octokit/openapi-types": "^7.4.0" } }, "@pika/babel-plugin-esm-import-rewrite": { diff --git a/package.json b/package.json index 7b9d63982..99c82f389 100644 --- a/package.json +++ b/package.json @@ -24,7 +24,7 @@ "author": "Gregor Martynus (https://twitter.com/gr2m)", "license": "MIT", "dependencies": { - "@octokit/types": "^6.16.7", + "@octokit/types": "^6.17.1", "deprecation": "^2.3.1" }, "devDependencies": { diff --git a/scripts/update-endpoints/generated/endpoints.json b/scripts/update-endpoints/generated/endpoints.json index 966309dd1..1f57d401f 100644 --- a/scripts/update-endpoints/generated/endpoints.json +++ b/scripts/update-endpoints/generated/endpoints.json @@ -11418,7 +11418,7 @@ "url": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "isDeprecated": false, "deprecationDate": null, - "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", "documentationUrl": "https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository", "previews": [], "headers": [], diff --git a/src/generated/method-types.ts b/src/generated/method-types.ts index 29c5bfb6e..f097d2e8b 100644 --- a/src/generated/method-types.ts +++ b/src/generated/method-types.ts @@ -2403,7 +2403,6 @@ export type RestEndpointMethods = { * the response contains the analysis data that was uploaded. * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). - * For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)." * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.