1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
use anyhow::Result; use crate::Client; pub struct CodeScanning { client: Client, } impl CodeScanning { #[doc(hidden)] pub fn new(client: Client) -> Self { CodeScanning { client } } /** * List code scanning alerts for a repository. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/alerts` endpoint. * * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use * this endpoint. GitHub Apps must have the `security_events` read permission to use * this endpoint. * * 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). * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `tool_name: &str` -- The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. * * `tool_guid: &str` -- The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. * * `page: i64` -- Page number of the results to fetch. * * `per_page: i64` -- Results per page (max 100). * * `ref_: &str` -- The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`. * * `state: crate::types::CodeScanningAlertState` -- Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state. */ pub async fn list_alerts_for_repo( &self, owner: &str, repo: &str, tool_name: &str, tool_guid: &str, page: i64, per_page: i64, ref_: &str, state: crate::types::CodeScanningAlertState, ) -> Result<Vec<crate::types::CodeScanningAlertItems>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if page > 0 { query_args.push(format!("page={}", page)); } if per_page > 0 { query_args.push(format!("per_page={}", per_page)); } if !ref_.is_empty() { query_args.push(format!("ref={}", ref_)); } query_args.push(format!("state={}", state)); if !tool_guid.is_empty() { query_args.push(format!("tool_guid={}", tool_guid)); } if !tool_name.is_empty() { query_args.push(format!("tool_name={}", tool_name)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/alerts?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), query ); self.client.get(&url, None).await } /** * List code scanning alerts for a repository. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/alerts` endpoint. * * As opposed to `list_alerts_for_repo`, this function returns all the pages of the request at once. * * Lists all open code scanning alerts for the default branch (usually `main` * or `master`). You must use an access token with the `security_events` scope to use * this endpoint. GitHub Apps must have the `security_events` read permission to use * this endpoint. * * 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). * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository> */ pub async fn list_all_alerts_for_repo( &self, owner: &str, repo: &str, tool_name: &str, tool_guid: &str, ref_: &str, state: crate::types::CodeScanningAlertState, ) -> Result<Vec<crate::types::CodeScanningAlertItems>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !ref_.is_empty() { query_args.push(format!("ref={}", ref_)); } query_args.push(format!("state={}", state)); if !tool_guid.is_empty() { query_args.push(format!("tool_guid={}", tool_guid)); } if !tool_name.is_empty() { query_args.push(format!("tool_name={}", tool_name)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/alerts?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), query ); self.client.get_all_pages(&url, None).await } /** * Get a code scanning alert. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}` endpoint. * * Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`. * * FROM: <https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-alert> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `alert_number: i64` -- The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ pub async fn get_alert( &self, owner: &str, repo: &str, alert_number: i64, ) -> Result<crate::types::CodeScanningAlert> { let url = format!( "/repos/{}/{}/code-scanning/alerts/{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&alert_number.to_string()), ); self.client.get(&url, None).await } /** * Update a code scanning alert. * * This function performs a `PATCH` to the `/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}` endpoint. * * Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. * * FROM: <https://docs.github.com/rest/reference/code-scanning#update-a-code-scanning-alert> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `alert_number: i64` -- The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. */ pub async fn update_alert( &self, owner: &str, repo: &str, alert_number: i64, body: &crate::types::CodeScanningUpdateAlertRequest, ) -> Result<crate::types::CodeScanningAlert> { let url = format!( "/repos/{}/{}/code-scanning/alerts/{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&alert_number.to_string()), ); self.client .patch( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * List instances of a code scanning alert. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances` endpoint. * * Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `alert_number: i64` -- The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation. * * `page: i64` -- Page number of the results to fetch. * * `per_page: i64` -- Results per page (max 100). * * `ref_: &str` -- The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`. */ pub async fn list_alert_instances( &self, owner: &str, repo: &str, alert_number: i64, page: i64, per_page: i64, ref_: &str, ) -> Result<Vec<crate::types::CodeScanningAlertInstance>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if page > 0 { query_args.push(format!("page={}", page)); } if per_page > 0 { query_args.push(format!("per_page={}", per_page)); } if !ref_.is_empty() { query_args.push(format!("ref={}", ref_)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/alerts/{}/instances?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&alert_number.to_string()), query ); self.client.get(&url, None).await } /** * List instances of a code scanning alert. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances` endpoint. * * As opposed to `list_alert_instances`, this function returns all the pages of the request at once. * * Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert> */ pub async fn list_all_alert_instances( &self, owner: &str, repo: &str, alert_number: i64, ref_: &str, ) -> Result<Vec<crate::types::CodeScanningAlertInstance>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !ref_.is_empty() { query_args.push(format!("ref={}", ref_)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/alerts/{}/instances?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&alert_number.to_string()), query ); self.client.get_all_pages(&url, None).await } /** * List code scanning analyses for a repository. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/analyses` endpoint. * * 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. * * You must use an access token with the `security_events` scope to use this endpoint. * GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `tool_name: &str` -- The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both. * * `tool_guid: &str` -- The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both. * * `page: i64` -- Page number of the results to fetch. * * `per_page: i64` -- Results per page (max 100). * * `ref_: &str` -- The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/<branch name>` or simply `<branch name>`. To reference a pull request use `refs/pull/<number>/merge`. * * `sarif_id: &str` -- Filter analyses belonging to the same SARIF upload. */ pub async fn list_recent_analyses( &self, owner: &str, repo: &str, tool_name: &str, tool_guid: &str, page: i64, per_page: i64, ref_: &str, sarif_id: &str, ) -> Result<Vec<crate::types::CodeScanningAnalysis>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if page > 0 { query_args.push(format!("page={}", page)); } if per_page > 0 { query_args.push(format!("per_page={}", per_page)); } if !ref_.is_empty() { query_args.push(format!("ref={}", ref_)); } if !sarif_id.is_empty() { query_args.push(format!("sarif_id={}", sarif_id)); } if !tool_guid.is_empty() { query_args.push(format!("tool_guid={}", tool_guid)); } if !tool_name.is_empty() { query_args.push(format!("tool_name={}", tool_name)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/analyses?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), query ); self.client.get(&url, None).await } /** * List code scanning analyses for a repository. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/analyses` endpoint. * * As opposed to `list_recent_analyses`, this function returns all the pages of the request at once. * * 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. * * You must use an access token with the `security_events` scope to use this endpoint. * GitHub Apps must have the `security_events` read permission to use this endpoint. * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository> */ pub async fn list_all_recent_analyses( &self, owner: &str, repo: &str, tool_name: &str, tool_guid: &str, ref_: &str, sarif_id: &str, ) -> Result<Vec<crate::types::CodeScanningAnalysis>> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !ref_.is_empty() { query_args.push(format!("ref={}", ref_)); } if !sarif_id.is_empty() { query_args.push(format!("sarif_id={}", sarif_id)); } if !tool_guid.is_empty() { query_args.push(format!("tool_guid={}", tool_guid)); } if !tool_name.is_empty() { query_args.push(format!("tool_name={}", tool_name)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/analyses?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), query ); self.client.get_all_pages(&url, None).await } /** * Get a code scanning analysis for a repository. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}` endpoint. * * Gets a specified code scanning analysis for a repository. * You must use an access token with the `security_events` scope to use this endpoint. * GitHub Apps must have the `security_events` read permission to use this endpoint. * * 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. * * If you use the Accept header `application/sarif+json`, * the response contains the analysis data that was uploaded. * This is formatted as * [SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html). * * **Deprecation notice**: * The `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field. * * FROM: <https://docs.github.com/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `analysis_id: i64` -- The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. */ pub async fn get_analysis( &self, owner: &str, repo: &str, analysis_id: i64, ) -> Result<crate::types::CodeScanningAnalysis> { let url = format!( "/repos/{}/{}/code-scanning/analyses/{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&analysis_id.to_string()), ); self.client.get(&url, None).await } /** * Delete a code scanning analysis from a repository. * * This function performs a `DELETE` to the `/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}` endpoint. * * Deletes a specified code scanning analysis from a repository. For * private repositories, you must use an access token with the `repo` scope. For public repositories, * you must use an access token with `public_repo` and `repo:security_events` scopes. * GitHub Apps must have the `security_events` write permission to use this endpoint. * * 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` * * `analysis_key` * * `environment` * * 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 * (see the example default response below). * Use the `next_analysis_url` URL if you want to avoid accidentally deleting the final analysis * in the 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 the deletable analysis for one of the sets, * step through deleting the analyses in that set, * and 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. * * FROM: <https://docs.github.com/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `analysis_id: i64` -- The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation. * * `confirm_delete: &str` -- Allow deletion if the specified analysis is the last in a set. If you attempt to delete the final analysis in a set without setting this parameter to `true`, you'll get a 400 response with the message: `Analysis is last of its type and deletion may result in the loss of historical alert data. Please specify confirm_delete.`. */ pub async fn delete_analysis( &self, owner: &str, repo: &str, analysis_id: i64, confirm_delete: &str, ) -> Result<crate::types::AnalysisDeletion> { let mut query = String::new(); let mut query_args: Vec<String> = Default::default(); if !confirm_delete.is_empty() { query_args.push(format!("confirm_delete={}", confirm_delete)); } for (i, n) in query_args.iter().enumerate() { if i > 0 { query.push('&'); } query.push_str(n); } let url = format!( "/repos/{}/{}/code-scanning/analyses/{}?{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&analysis_id.to_string()), query ); self.client.delete(&url, None).await } /** * Upload an analysis as SARIF data. * * This function performs a `POST` to the `/repos/{owner}/{repo}/code-scanning/sarifs` endpoint. * * Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint. * * 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](/code-security/secure-coding/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](/code-security/secure-coding/managing-code-scanning-alerts-for-your-repository#viewing-the-alerts-for-a-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 of 5000 results per analysis run. Any results over this limit are ignored and any SARIF uploads with more than 25,000 results are rejected. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries. * * The `202 Accepted`, response includes an `id` value. * You can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint. * For more information, see "[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload)." * * FROM: <https://docs.github.com/rest/reference/code-scanning#upload-a-sarif-file> * * **Parameters:** * * * `owner: &str` * * `repo: &str` */ pub async fn upload_sarif( &self, owner: &str, repo: &str, body: &crate::types::CodeScanningUploadSarifRequest, ) -> Result<crate::types::CodeScanningSarifsReceipt> { let url = format!( "/repos/{}/{}/code-scanning/sarifs", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), ); self.client .post( &url, Some(reqwest::Body::from(serde_json::to_vec(body).unwrap())), ) .await } /** * Get information about a SARIF upload. * * This function performs a `GET` to the `/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}` endpoint. * * 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](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository)." You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint. * * FROM: <https://docs.github.com/rest/reference/code-scanning#list-recent-code-scanning-analyses-for-a-repository> * * **Parameters:** * * * `owner: &str` * * `repo: &str` * * `sarif_id: &str` -- The SARIF ID obtained after uploading. */ pub async fn get_sarif( &self, owner: &str, repo: &str, sarif_id: &str, ) -> Result<crate::types::CodeScanningSarifsStatus> { let url = format!( "/repos/{}/{}/code-scanning/sarifs/{}", crate::progenitor_support::encode_path(&owner.to_string()), crate::progenitor_support::encode_path(&repo.to_string()), crate::progenitor_support::encode_path(&sarif_id.to_string()), ); self.client.get(&url, None).await } }