Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
", "statusCodes": [ { "httpStatusCode": "202", @@ -231796,6 +231796,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -234272,6 +234279,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -235638,6 +235652,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -236906,6 +236927,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -238186,6 +238214,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -239891,6 +239926,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -241983,6 +242025,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -352207,6 +352256,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -353224,6 +353338,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -354398,6 +354577,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -355587,6 +355831,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -356610,6 +356919,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -357785,6 +358159,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -373838,6 +374277,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -374157,6 +374598,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -477369,6 +477812,97 @@ } } ] + }, + { + "allOf": [ + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] } ] } @@ -478553,6 +479087,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -479432,6 +480031,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -480587,6 +481251,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -481787,6 +482516,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -482672,6 +483466,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -483828,6 +484687,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -544526,6 +545450,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -544802,6 +545736,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -545153,6 +546094,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -545429,6 +546380,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -545887,6 +546845,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -546587,6 +547555,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -546863,6 +547841,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -547223,6 +548208,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -547499,6 +548494,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", diff --git a/src/rest/data/ghec-2022-11-28/schema.json b/src/rest/data/ghec-2022-11-28/schema.json index 9f8c7616c179..6190a514948c 100644 --- a/src/rest/data/ghec-2022-11-28/schema.json +++ b/src/rest/data/ghec-2022-11-28/schema.json @@ -158714,7 +158714,7 @@ } ], "previews": [], - "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
", "statusCodes": [ { "httpStatusCode": "202", @@ -250906,6 +250906,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -253382,6 +253389,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -254748,6 +254762,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -256016,6 +256037,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -257296,6 +257324,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -259001,6 +259036,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -261093,6 +261135,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -375054,6 +375103,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -376071,6 +376185,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -377245,6 +377424,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -378434,6 +378678,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -379457,6 +379766,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -380632,6 +381006,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -396793,6 +397232,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -397112,6 +397553,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -500619,6 +501062,97 @@ } } ] + }, + { + "allOf": [ + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } + }, + { + "title": "repository ruleset data for rule", + "description": "User-defined metadata to store domain-specific information limited to 8 keys with scalar values.", + "properties": { + "ruleset_source_type": { + "type": "string", + "description": "The type of source for the ruleset that includes this rule.", + "enum": [ + "Repository", + "Organization" + ] + }, + "ruleset_source": { + "type": "string", + "description": "The name of the source of the ruleset that includes this rule." + }, + "ruleset_id": { + "type": "integer", + "description": "The ID of the ruleset that includes this rule." + } + } + } + ] } ] } @@ -501803,6 +502337,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -502682,6 +503281,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -503837,6 +504501,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -505037,6 +505766,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -505922,6 +506716,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -507078,6 +507937,71 @@ ] } } + }, + { + "title": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "type": "string", + "enum": [ + "code_scanning" + ] + }, + "parameters": { + "type": "object", + "properties": { + "code_scanning_tools": { + "type": "array", + "description": "Tools that must provide code scanning results for this rule to pass.", + "items": { + "title": "CodeScanningTool", + "description": "A tool that must provide code scanning results for this rule to pass.", + "type": "object", + "properties": { + "alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + "security_alerts_threshold": { + "type": "string", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest//code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + "tool": { + "type": "string", + "description": "The name of a code scanning tool" + } + }, + "required": [ + "alerts_threshold", + "security_alerts_threshold", + "tool" + ] + } + } + }, + "required": [ + "code_scanning_tools" + ] + } + } } ] } @@ -572016,6 +572940,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -572292,6 +573226,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -572643,6 +573584,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -572919,6 +573870,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -573377,6 +574335,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -574077,6 +575045,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -574353,6 +575331,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -574713,6 +575698,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -574989,6 +575984,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", diff --git a/src/rest/data/ghes-3.10-2022-11-28/schema.json b/src/rest/data/ghes-3.10-2022-11-28/schema.json index cdf235ac733c..3bafd435f492 100644 --- a/src/rest/data/ghes-3.10-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.10-2022-11-28/schema.json @@ -151628,7 +151628,7 @@ } ], "previews": [], - "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
", "statusCodes": [ { "httpStatusCode": "202", @@ -210127,6 +210127,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -212603,6 +212610,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -213969,6 +213983,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -215237,6 +215258,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -216517,6 +216545,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -218222,6 +218257,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -220314,6 +220356,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -344207,6 +344256,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -344526,6 +344577,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -483070,6 +483123,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -483346,6 +483409,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -483696,6 +483766,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -483972,6 +484052,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -484429,6 +484516,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -485129,6 +485226,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -485405,6 +485512,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -485765,6 +485879,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -486041,6 +486165,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", diff --git a/src/rest/data/ghes-3.11-2022-11-28/schema.json b/src/rest/data/ghes-3.11-2022-11-28/schema.json index 725849181cf4..126c09e75474 100644 --- a/src/rest/data/ghes-3.11-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.11-2022-11-28/schema.json @@ -151664,7 +151664,7 @@ } ], "previews": [], - "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
", "statusCodes": [ { "httpStatusCode": "202", @@ -210192,6 +210192,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -212668,6 +212675,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -214034,6 +214048,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -215302,6 +215323,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -216582,6 +216610,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -218287,6 +218322,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -220379,6 +220421,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -349825,6 +349874,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -350144,6 +350195,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -497129,6 +497182,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -497405,6 +497468,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -497755,6 +497825,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -498031,6 +498111,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -498488,6 +498575,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -499188,6 +499285,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -499464,6 +499571,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -499824,6 +499938,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -500100,6 +500224,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", diff --git a/src/rest/data/ghes-3.12-2022-11-28/schema.json b/src/rest/data/ghes-3.12-2022-11-28/schema.json index 6da4970ee967..1132894eedb7 100644 --- a/src/rest/data/ghes-3.12-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.12-2022-11-28/schema.json @@ -151985,7 +151985,7 @@ } ], "previews": [], - "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
", "statusCodes": [ { "httpStatusCode": "202", @@ -212449,6 +212449,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -214925,6 +214932,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -216291,6 +216305,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -217559,6 +217580,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -218839,6 +218867,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -220544,6 +220579,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -222636,6 +222678,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -352703,6 +352752,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -353022,6 +353073,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -500614,6 +500667,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -500890,6 +500953,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -501240,6 +501310,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -501516,6 +501596,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -501973,6 +502060,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -502673,6 +502770,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -502949,6 +503056,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -503309,6 +503423,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -503585,6 +503709,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", diff --git a/src/rest/data/ghes-3.9-2022-11-28/schema.json b/src/rest/data/ghes-3.9-2022-11-28/schema.json index 5fe0a22dbea3..babac649af04 100644 --- a/src/rest/data/ghes-3.9-2022-11-28/schema.json +++ b/src/rest/data/ghes-3.9-2022-11-28/schema.json @@ -150323,7 +150323,7 @@ } ], "previews": [], - "descriptionHTML": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. For troubleshooting information, see \"Troubleshooting SARIF uploads.\"
\nThere are two places where you can upload code scanning results.
\n--ref refs/pull/42/merge or --ref refs/pull/42/head, then the results appear as alerts in a pull request check. For more information, see \"Triaging code scanning alerts in pull requests.\"--ref refs/heads/my-branch, then the results appear in the Security tab for your repository. For more information, see \"Managing code scanning alerts for your repository.\"You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:
gzip -c analysis-data.sarif | base64 -w0\nSARIF upload supports a maximum number of entries per the following data objects, and an analysis will be rejected if any of these objects is above its maximum value. For some objects, there are additional values over which the entries will be ignored while keeping the most important entries whenever applicable.\nTo get the most out of your analysis when it includes data above the supported limits, try to optimize the analysis configuration. For example, for the CodeQL tool, identify and remove the most noisy queries. For more information, see \"SARIF results exceed one or more limits.\"
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n| SARIF data | Maximum values | Additional limits |
|---|---|---|
| Runs per file | 20 | |
| Results per run | 25,000 | Only the top 5,000 results will be included, prioritized by severity. |
| Rules per run | 25,000 | |
| Tool extensions per run | 100 | |
| Thread Flow Locations per result | 10,000 | Only the top 1,000 Thread Flow Locations will be included, using prioritization. |
| Location per result | 1,000 | Only 100 locations will be included. |
| Tags per rule | 20 | Only 10 tags will be included. |
The 202 Accepted response includes an id value.\nYou can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"
OAuth app tokens and personal access tokens (classic) need the security_events scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.
This endpoint is limited to 1,000 requests per hour for each user or app installation calling it.
", "statusCodes": [ { "httpStatusCode": "202", @@ -207504,6 +207504,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -209980,6 +209987,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -211346,6 +211360,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -212614,6 +212635,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -213894,6 +213922,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -215599,6 +215634,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -217691,6 +217733,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -337978,6 +338027,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -338297,6 +338348,8 @@ "path": "/" }, "public": true, + "pending_domain_unverified_at": "2024-04-30T19:33:31Z", + "protected_domain_state": "verified", "https_certificate": { "state": "approved", "description": "Certificate is approved", @@ -476224,6 +476277,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -476500,6 +476563,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -476850,6 +476920,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -477126,6 +477206,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -477583,6 +477670,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -478283,6 +478380,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -478559,6 +478666,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", @@ -478919,6 +479033,16 @@ "octocat@github.com" ] }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email", + "examples": [ + "octocat@github.com" + ] + }, "hireable": { "type": [ "boolean", @@ -479195,6 +479319,13 @@ ], "format": "email" }, + "notification_email": { + "type": [ + "string", + "null" + ], + "format": "email" + }, "hireable": { "type": [ "boolean", diff --git a/src/rest/lib/config.json b/src/rest/lib/config.json index a8f43e1f5c47..35a8f24e636f 100644 --- a/src/rest/lib/config.json +++ b/src/rest/lib/config.json @@ -44,5 +44,5 @@ ] } }, - "sha": "9d72fe2fc88c7c44f95f98997e39446e12b395e2" + "sha": "51df3ba1046325354c9819e8175b6407a2171185" } \ No newline at end of file diff --git a/src/webhooks/data/fpt/schema.json b/src/webhooks/data/fpt/schema.json index d5681259ecb9..8a63f93c7a1c 100644 --- a/src/webhooks/data/fpt/schema.json +++ b/src/webhooks/data/fpt/schema.json @@ -202169,6 +202169,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -203110,6 +203175,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -204051,6 +204181,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -204967,6 +205162,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -205695,6 +205955,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -206428,6 +206753,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/data/ghec/schema.json b/src/webhooks/data/ghec/schema.json index a8199d5b991c..40a7027dd8f4 100644 --- a/src/webhooks/data/ghec/schema.json +++ b/src/webhooks/data/ghec/schema.json @@ -202233,6 +202233,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -203174,6 +203239,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -204115,6 +204245,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -205031,6 +205226,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -205759,6 +206019,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true @@ -206492,6 +206817,71 @@ ] } ] + }, + { + "type": "object", + "name": "code_scanning", + "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.
", + "isRequired": [ + "type" + ], + "childParamsGroups": [ + { + "type": "string", + "name": "type", + "description": "", + "isRequired": true, + "enum": [ + "code_scanning" + ] + }, + { + "type": "object", + "name": "parameters", + "description": "", + "childParamsGroups": [ + { + "type": "array of objects", + "name": "code_scanning_tools", + "description": "Tools that must provide code scanning results for this rule to pass.
", + "isRequired": true, + "childParamsGroups": [ + { + "type": "string", + "name": "alerts_threshold", + "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "errors", + "errors_and_warnings", + "all" + ] + }, + { + "type": "string", + "name": "security_alerts_threshold", + "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"About code scanning alerts.\"
", + "isRequired": true, + "enum": [ + "none", + "critical", + "high_or_higher", + "medium_or_higher", + "all" + ] + }, + { + "type": "string", + "name": "tool", + "description": "The name of a code scanning tool
", + "isRequired": true + } + ] + } + ] + } + ] } ], "oneOfObject": true diff --git a/src/webhooks/lib/config.json b/src/webhooks/lib/config.json index 899d694b5ab6..3a44629684a2 100644 --- a/src/webhooks/lib/config.json +++ b/src/webhooks/lib/config.json @@ -1,3 +1,3 @@ { - "sha": "9d72fe2fc88c7c44f95f98997e39446e12b395e2" + "sha": "51df3ba1046325354c9819e8175b6407a2171185" } \ No newline at end of file