Skip to content

Commit c1d9219

Browse files
authored
feat: .security_and_analysis.secret_scanning property in full-repository schema via @octokit/types v2.23.0 (#108)
1 parent d57985c commit c1d9219

File tree

3 files changed

+15
-5
lines changed

3 files changed

+15
-5
lines changed

cache/openapi-schema.json

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"openapi": "3.0.3",
33
"info": {
4-
"version": "2.22.5",
4+
"version": "2.23.0",
55
"title": "GitHub's official OpenAPI spec + Octokit extension",
66
"description": "OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs",
77
"license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" },
@@ -18416,7 +18416,7 @@
1841618416
"/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": {
1841718417
"get": {
1841818418
"summary": "Get a code scanning analysis for a repository",
18419-
"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.",
18419+
"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.",
1842018420
"operationId": "code-scanning/get-analysis",
1842118421
"tags": ["code-scanning"],
1842218422
"externalDocs": {
@@ -45060,6 +45060,15 @@
4506045060
"enum": ["enabled", "disabled"]
4506145061
}
4506245062
}
45063+
},
45064+
"secret_scanning": {
45065+
"type": "object",
45066+
"properties": {
45067+
"status": {
45068+
"type": "string",
45069+
"enum": ["enabled", "disabled"]
45070+
}
45071+
}
4506345072
}
4506445073
}
4506545074
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
]
5454
},
5555
"octokit": {
56-
"openapi-version": "2.22.5"
56+
"openapi-version": "2.23.0"
5757
},
5858
"@pika/pack": {
5959
"pipeline": [

src/generated/types.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2521,7 +2521,6 @@ export interface paths {
25212521
* the response contains the analysis data that was uploaded.
25222522
* This is formatted as
25232523
* [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
2524-
* For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)."
25252524
*
25262525
* **Deprecation notice**:
25272526
* 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.
@@ -7264,6 +7263,9 @@ export interface components {
72647263
advanced_security?: {
72657264
status?: "enabled" | "disabled";
72667265
};
7266+
secret_scanning?: {
7267+
status?: "enabled" | "disabled";
7268+
};
72677269
} | null;
72687270
};
72697271
/** An artifact */
@@ -21263,7 +21265,6 @@ export interface operations {
2126321265
* the response contains the analysis data that was uploaded.
2126421266
* This is formatted as
2126521267
* [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).
21266-
* For an example response, see "[Custom media type for code scanning](#custom-media-type-for-code-scanning)."
2126721268
*
2126821269
* **Deprecation notice**:
2126921270
* 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.

0 commit comments

Comments
 (0)