Struct CodeScanning

pub struct CodeScanning<'api, C: Client>
where
    AdapterError: From<<C as Client>::Err>,
{ /* private fields */ }

Implementations

impl<'api, C: Client> CodeScanning<'api, C>

where AdapterError: From<<C as Client>::Err>,

pub async fn commit_autofix_async( &self, owner: &str, repo: &str, alert_number: AlertNumber, body: PostCodeScanningCommitAutofix, ) -> Result<CodeScanningAutofixCommitsResponse, AdapterError>

---

Commit an autofix for a code scanning alert

Commits an autofix for a code scanning alert.

If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for commit_autofix

---

pub fn commit_autofix( &self, owner: &str, repo: &str, alert_number: AlertNumber, body: PostCodeScanningCommitAutofix, ) -> Result<CodeScanningAutofixCommitsResponse, AdapterError>

---

Commit an autofix for a code scanning alert

Commits an autofix for a code scanning alert.

If an autofix is committed as a result of this request, then this endpoint will return a 201 Created response.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for commit_autofix

---

pub async fn create_autofix_async( &self, owner: &str, repo: &str, alert_number: AlertNumber, ) -> Result<CodeScanningAutofix, AdapterError>

---

Create an autofix for a code scanning alert

Creates an autofix for a code scanning alert.

If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.

If an autofix already exists for a given alert, then this endpoint will return a 200 OK response.

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.

GitHub API docs for create_autofix

---

pub fn create_autofix( &self, owner: &str, repo: &str, alert_number: AlertNumber, ) -> Result<CodeScanningAutofix, AdapterError>

---

Create an autofix for a code scanning alert

Creates an autofix for a code scanning alert.

If a new autofix is to be created as a result of this request or is currently being generated, then this endpoint will return a 202 Accepted response.

If an autofix already exists for a given alert, then this endpoint will return a 200 OK response.

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.

GitHub API docs for create_autofix

---

pub async fn create_variant_analysis_async( &self, owner: &str, repo: &str, body: PostCodeScanningCreateVariantAnalysis, ) -> Result<CodeScanningVariantAnalysis, AdapterError>

---

Create a CodeQL variant analysis

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.

Use the owner and repo parameters in the URL to specify the controller repository that will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

GitHub API docs for create_variant_analysis

---

pub fn create_variant_analysis( &self, owner: &str, repo: &str, body: PostCodeScanningCreateVariantAnalysis, ) -> Result<CodeScanningVariantAnalysis, AdapterError>

---

Create a CodeQL variant analysis

Creates a new CodeQL variant analysis, which will run a CodeQL query against one or more repositories.

Get started by learning more about running CodeQL queries at scale with Multi-Repository Variant Analysis.

Use the owner and repo parameters in the URL to specify the controller repository that will be used for running GitHub Actions workflows and storing the results of the CodeQL variant analysis.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint.

GitHub API docs for create_variant_analysis

---

pub async fn delete_analysis_async( &self, owner: &str, repo: &str, analysis_id: i32, query_params: Option<impl Into<CodeScanningDeleteAnalysisParams<'api>>>, ) -> Result<CodeScanningAnalysisDeletion, AdapterError>

---

Delete a code scanning analysis from a repository

Deletes a specified code scanning analysis from a repository.

You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository, one or more will be identified as deletable in the response:

"deletable": true

An analysis is deletable when it’s the most recent in a set of analyses. Typically, a repository will have multiple sets of analyses for each enabled code scanning tool, where a set is determined by a unique combination of analysis values:

• ref
• tool
• category

If you attempt to delete an analysis that is not the most recent in a set, you’ll get a 400 response with the message:

Analysis specified is not deletable.

The response from a successful DELETE operation provides you with two alternative URLs for deleting the next analysis in the set: next_analysis_url and confirm_delete_url. Use the next_analysis_url URL if you want to avoid accidentally deleting the final analysis in a set. This is a useful option if you want to preserve at least one analysis for the specified tool in your repository. Use the confirm_delete_url URL if you are content to remove all analyses for a tool. When you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url in the 200 response is null.

As an example of the deletion process, let’s imagine that you added a workflow that configured a particular code scanning tool to analyze the code in a repository. This tool has added 15 analyses: 10 on the default branch, and another 5 on a topic branch. You therefore have two separate sets of analyses for this tool. You’ve now decided that you want to remove all of the analyses for the tool. To do this you must make 15 separate deletion requests. To start, you must find an analysis that’s identified as deletable. Each set of analyses always has one that’s identified as deletable. Having found the deletable analysis for one of the two sets, delete this analysis and then continue deleting the next analysis in the set until they’re all deleted. Then repeat the process for the second set. The procedure therefore consists of a nested loop:

Outer loop:

• List the analyses for the repository, filtered by tool.

• Parse this list to find a deletable analysis. If found:

  Inner loop:

  • Delete the identified analysis.
  • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool’s analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool’s analysis entirely.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for delete_analysis

---

pub fn delete_analysis( &self, owner: &str, repo: &str, analysis_id: i32, query_params: Option<impl Into<CodeScanningDeleteAnalysisParams<'api>>>, ) -> Result<CodeScanningAnalysisDeletion, AdapterError>

---

Delete a code scanning analysis from a repository

Deletes a specified code scanning analysis from a repository.

You can delete one analysis at a time. To delete a series of analyses, start with the most recent analysis and work backwards. Conceptually, the process is similar to the undo function in a text editor.

When you list the analyses for a repository, one or more will be identified as deletable in the response:

"deletable": true

An analysis is deletable when it’s the most recent in a set of analyses. Typically, a repository will have multiple sets of analyses for each enabled code scanning tool, where a set is determined by a unique combination of analysis values:

• ref
• tool
• category

If you attempt to delete an analysis that is not the most recent in a set, you’ll get a 400 response with the message:

Analysis specified is not deletable.

The response from a successful DELETE operation provides you with two alternative URLs for deleting the next analysis in the set: next_analysis_url and confirm_delete_url. Use the next_analysis_url URL if you want to avoid accidentally deleting the final analysis in a set. This is a useful option if you want to preserve at least one analysis for the specified tool in your repository. Use the confirm_delete_url URL if you are content to remove all analyses for a tool. When you delete the last analysis in a set, the value of next_analysis_url and confirm_delete_url in the 200 response is null.

As an example of the deletion process, let’s imagine that you added a workflow that configured a particular code scanning tool to analyze the code in a repository. This tool has added 15 analyses: 10 on the default branch, and another 5 on a topic branch. You therefore have two separate sets of analyses for this tool. You’ve now decided that you want to remove all of the analyses for the tool. To do this you must make 15 separate deletion requests. To start, you must find an analysis that’s identified as deletable. Each set of analyses always has one that’s identified as deletable. Having found the deletable analysis for one of the two sets, delete this analysis and then continue deleting the next analysis in the set until they’re all deleted. Then repeat the process for the second set. The procedure therefore consists of a nested loop:

Outer loop:

• List the analyses for the repository, filtered by tool.

• Parse this list to find a deletable analysis. If found:

  Inner loop:

  • Delete the identified analysis.
  • Parse the response for the value of confirm_delete_url and, if found, use this in the next iteration.

The above process assumes that you want to remove all trace of the tool’s analyses from the GitHub user interface, for the specified repository, and it therefore uses the confirm_delete_url value. Alternatively, you could use the next_analysis_url value, which would leave the last analysis in each set undeleted to avoid removing a tool’s analysis entirely.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for delete_analysis

---

pub async fn delete_codeql_database_async( &self, owner: &str, repo: &str, language: &str, ) -> Result<(), AdapterError>

---

Delete a CodeQL database

Deletes a CodeQL database for a language in a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for delete_codeql_database

---

pub fn delete_codeql_database( &self, owner: &str, repo: &str, language: &str, ) -> Result<(), AdapterError>

---

Delete a CodeQL database

Deletes a CodeQL database for a language in a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for delete_codeql_database

---

pub async fn get_alert_async( &self, owner: &str, repo: &str, alert_number: AlertNumber, ) -> Result<CodeScanningAlert, AdapterError>

---

Get a code scanning alert

Gets a single code scanning alert.

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.

GitHub API docs for get_alert

---

pub fn get_alert( &self, owner: &str, repo: &str, alert_number: AlertNumber, ) -> Result<CodeScanningAlert, AdapterError>

---

Get a code scanning alert

Gets a single code scanning alert.

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.

GitHub API docs for get_alert

---

pub async fn get_analysis_async( &self, owner: &str, repo: &str, analysis_id: i32, ) -> Result<CodeScanningAnalysis, AdapterError>

---

Get a code scanning analysis for a repository

Gets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, the datetime of the analysis, the name of the code scanning tool, and the number of alerts.

The rules_count field in the default response give the number of rules that were run in the analysis. For very old analyses this data is not available, and 0 is returned in this field.

This endpoint supports the following custom media types. For more information, see “Media types.”

• application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.

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.

GitHub API docs for get_analysis

---

pub fn get_analysis( &self, owner: &str, repo: &str, analysis_id: i32, ) -> Result<CodeScanningAnalysis, AdapterError>

---

Get a code scanning analysis for a repository

Gets a specified code scanning analysis for a repository.

The default JSON response contains fields that describe the analysis. This includes the Git reference and commit SHA to which the analysis relates, the datetime of the analysis, the name of the code scanning tool, and the number of alerts.

The rules_count field in the default response give the number of rules that were run in the analysis. For very old analyses this data is not available, and 0 is returned in this field.

This endpoint supports the following custom media types. For more information, see “Media types.”

• application/sarif+json: Instead of returning a summary of the analysis, this endpoint returns a subset of the analysis data that was uploaded. The data is formatted as SARIF version 2.1.0. It also returns additional data such as the github/alertNumber and github/alertUrl properties.

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.

GitHub API docs for get_analysis

---

pub async fn get_autofix_async( &self, owner: &str, repo: &str, alert_number: AlertNumber, ) -> Result<CodeScanningAutofix, AdapterError>

---

Get the status of an autofix for a code scanning alert

Gets the status and description of an autofix for a code scanning alert.

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.

GitHub API docs for get_autofix

---

pub fn get_autofix( &self, owner: &str, repo: &str, alert_number: AlertNumber, ) -> Result<CodeScanningAutofix, AdapterError>

---

Get the status of an autofix for a code scanning alert

Gets the status and description of an autofix for a code scanning alert.

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.

GitHub API docs for get_autofix

---

pub async fn get_codeql_database_async( &self, owner: &str, repo: &str, language: &str, ) -> Result<CodeScanningCodeqlDatabase, AdapterError>

---

Get a CodeQL database for a repository

Gets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To download the CodeQL database binary content, set the Accept header of the request to application/zip, and make sure your HTTP client is configured to follow redirects or use the Location header to make a second request to get the redirect URL.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for get_codeql_database

---

pub fn get_codeql_database( &self, owner: &str, repo: &str, language: &str, ) -> Result<CodeScanningCodeqlDatabase, AdapterError>

---

Get a CodeQL database for a repository

Gets a CodeQL database for a language in a repository.

By default this endpoint returns JSON metadata about the CodeQL database. To download the CodeQL database binary content, set the Accept header of the request to application/zip, and make sure your HTTP client is configured to follow redirects or use the Location header to make a second request to get the redirect URL.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for get_codeql_database

---

pub async fn get_default_setup_async( &self, owner: &str, repo: &str, ) -> Result<CodeScanningDefaultSetup, AdapterError>

---

Get a code scanning default setup configuration

Gets a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for get_default_setup

---

pub fn get_default_setup( &self, owner: &str, repo: &str, ) -> Result<CodeScanningDefaultSetup, AdapterError>

---

Get a code scanning default setup configuration

Gets a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for get_default_setup

---

pub async fn get_sarif_async( &self, owner: &str, repo: &str, sarif_id: &str, ) -> Result<CodeScanningSarifsStatus, AdapterError>

---

Get information about a SARIF upload

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see “Get a code scanning analysis for a repository.” 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.

GitHub API docs for get_sarif

---

pub fn get_sarif( &self, owner: &str, repo: &str, sarif_id: &str, ) -> Result<CodeScanningSarifsStatus, AdapterError>

---

Get information about a SARIF upload

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see “Get a code scanning analysis for a repository.” 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.

GitHub API docs for get_sarif

---

pub async fn get_variant_analysis_async( &self, owner: &str, repo: &str, codeql_variant_analysis_id: i32, ) -> Result<CodeScanningVariantAnalysis, AdapterError>

---

Get the summary of a CodeQL variant analysis

Gets the summary of a CodeQL variant analysis.

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.

GitHub API docs for get_variant_analysis

---

pub fn get_variant_analysis( &self, owner: &str, repo: &str, codeql_variant_analysis_id: i32, ) -> Result<CodeScanningVariantAnalysis, AdapterError>

---

Get the summary of a CodeQL variant analysis

Gets the summary of a CodeQL variant analysis.

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.

GitHub API docs for get_variant_analysis

---

pub async fn get_variant_analysis_repo_task_async( &self, owner: &str, repo: &str, codeql_variant_analysis_id: i32, repo_owner: &str, repo_name: &str, ) -> Result<CodeScanningVariantAnalysisRepoTask, AdapterError>

---

Get the analysis status of a repository in a CodeQL variant analysis

Gets the analysis status of a repository in a CodeQL variant analysis.

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.

GitHub API docs for get_variant_analysis_repo_task

---

pub fn get_variant_analysis_repo_task( &self, owner: &str, repo: &str, codeql_variant_analysis_id: i32, repo_owner: &str, repo_name: &str, ) -> Result<CodeScanningVariantAnalysisRepoTask, AdapterError>

---

Get the analysis status of a repository in a CodeQL variant analysis

Gets the analysis status of a repository in a CodeQL variant analysis.

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.

GitHub API docs for get_variant_analysis_repo_task

---

pub async fn list_alert_instances_async( &self, owner: &str, repo: &str, alert_number: AlertNumber, query_params: Option<impl Into<CodeScanningListAlertInstancesParams>>, ) -> Result<Vec<CodeScanningAlertInstance>, AdapterError>

---

List instances of a code scanning alert

Lists all instances of the specified code scanning alert.

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.

GitHub API docs for list_alert_instances

---

pub fn list_alert_instances( &self, owner: &str, repo: &str, alert_number: AlertNumber, query_params: Option<impl Into<CodeScanningListAlertInstancesParams>>, ) -> Result<Vec<CodeScanningAlertInstance>, AdapterError>

---

List instances of a code scanning alert

Lists all instances of the specified code scanning alert.

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.

GitHub API docs for list_alert_instances

---

pub async fn list_alerts_for_org_async( &self, org: &str, query_params: Option<impl Into<CodeScanningListAlertsForOrgParams<'api>>>, ) -> Result<Vec<CodeScanningOrganizationAlertItems>, AdapterError>

---

List code scanning alerts for an organization

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see “Managing security managers in your organization.”

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for list_alerts_for_org

---

pub fn list_alerts_for_org( &self, org: &str, query_params: Option<impl Into<CodeScanningListAlertsForOrgParams<'api>>>, ) -> Result<Vec<CodeScanningOrganizationAlertItems>, AdapterError>

---

List code scanning alerts for an organization

Lists code scanning alerts for the default branch for all eligible repositories in an organization. Eligible repositories are repositories that are owned by organizations that you own or for which you are a security manager. For more information, see “Managing security managers in your organization.”

The authenticated user must be an owner or security manager for the organization to use this endpoint.

OAuth app tokens and personal access tokens (classic) need the security_events or repos cope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for list_alerts_for_org

---

pub async fn list_alerts_for_repo_async( &self, owner: &str, repo: &str, query_params: Option<impl Into<CodeScanningListAlertsForRepoParams<'api>>>, ) -> Result<Vec<CodeScanningAlertItems>, AdapterError>

---

List code scanning alerts for a repository

Lists code scanning alerts.

The response includes a most_recent_instance object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used ref in the request).

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.

GitHub API docs for list_alerts_for_repo

---

pub fn list_alerts_for_repo( &self, owner: &str, repo: &str, query_params: Option<impl Into<CodeScanningListAlertsForRepoParams<'api>>>, ) -> Result<Vec<CodeScanningAlertItems>, AdapterError>

---

List code scanning alerts for a repository

Lists code scanning alerts.

The response includes a most_recent_instance object. This provides details of the most recent instance of this alert for the default branch (or for the specified Git reference if you used ref in the request).

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.

GitHub API docs for list_alerts_for_repo

---

pub async fn list_codeql_databases_async( &self, owner: &str, repo: &str, ) -> Result<Vec<CodeScanningCodeqlDatabase>, AdapterError>

---

List CodeQL databases for a repository

Lists the CodeQL databases that are available in a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for list_codeql_databases

---

pub fn list_codeql_databases( &self, owner: &str, repo: &str, ) -> Result<Vec<CodeScanningCodeqlDatabase>, AdapterError>

---

List CodeQL databases for a repository

Lists the CodeQL databases that are available in a repository.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for list_codeql_databases

---

pub async fn list_recent_analyses_async( &self, owner: &str, repo: &str, query_params: Option<impl Into<CodeScanningListRecentAnalysesParams<'api>>>, ) -> Result<Vec<CodeScanningAnalysis>, AdapterError>

---

List code scanning analyses for a repository

Lists the details of all code scanning analyses for a repository, starting with the most recent. The response is paginated and you can use the page and per_page parameters to list the analyses you’re interested in. By default 30 analyses are listed per page.

The rules_count field in the response give the number of rules that were run in the analysis. For very old analyses this data is not available, and 0 is returned in this field.

[!WARNING] Closing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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.

GitHub API docs for list_recent_analyses

---

pub fn list_recent_analyses( &self, owner: &str, repo: &str, query_params: Option<impl Into<CodeScanningListRecentAnalysesParams<'api>>>, ) -> Result<Vec<CodeScanningAnalysis>, AdapterError>

---

List code scanning analyses for a repository

Lists the details of all code scanning analyses for a repository, starting with the most recent. The response is paginated and you can use the page and per_page parameters to list the analyses you’re interested in. By default 30 analyses are listed per page.

The rules_count field in the response give the number of rules that were run in the analysis. For very old analyses this data is not available, and 0 is returned in this field.

[!WARNING] Closing down notice: The tool_name field is closing down and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

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.

GitHub API docs for list_recent_analyses

---

pub async fn update_alert_async( &self, owner: &str, repo: &str, alert_number: AlertNumber, body: PatchCodeScanningUpdateAlert, ) -> Result<CodeScanningAlert, AdapterError>

---

Update a code scanning alert

Updates the status of a single code scanning alert. 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.

GitHub API docs for update_alert

---

pub fn update_alert( &self, owner: &str, repo: &str, alert_number: AlertNumber, body: PatchCodeScanningUpdateAlert, ) -> Result<CodeScanningAlert, AdapterError>

---

Update a code scanning alert

Updates the status of a single code scanning alert. 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.

GitHub API docs for update_alert

---

pub async fn update_default_setup_async( &self, owner: &str, repo: &str, body: PatchCodeScanningUpdateDefaultSetup, ) -> Result<EmptyObject, AdapterError>

---

Update a code scanning default setup configuration

Updates a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for update_default_setup

---

pub fn update_default_setup( &self, owner: &str, repo: &str, body: PatchCodeScanningUpdateDefaultSetup, ) -> Result<EmptyObject, AdapterError>

---

Update a code scanning default setup configuration

Updates a code scanning default setup configuration.

OAuth app tokens and personal access tokens (classic) need the repo scope to use this endpoint with private or public repositories, or the public_repo scope to use this endpoint with only public repositories.

GitHub API docs for update_default_setup

---

pub async fn upload_sarif_async( &self, owner: &str, repo: &str, body: PostCodeScanningUploadSarif, ) -> Result<CodeScanningSarifsReceipt, AdapterError>

---

Upload an analysis as SARIF data

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.”

There are two places where you can upload code scanning results.

• If you upload to a pull request, for example --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.”
• If you upload to a branch, for example --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

SARIF 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. To 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.”

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. You can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint. For 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.

GitHub API docs for upload_sarif

---

pub fn upload_sarif( &self, owner: &str, repo: &str, body: PostCodeScanningUploadSarif, ) -> Result<CodeScanningSarifsReceipt, AdapterError>

---

Upload an analysis as SARIF data

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.”

There are two places where you can upload code scanning results.

• If you upload to a pull request, for example --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.”
• If you upload to a branch, for example --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

SARIF 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. To 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.”

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. You can use this ID to check the status of the upload by using it in the /sarifs/{sarif_id} endpoint. For 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.

GitHub API docs for upload_sarif

---