feat:Update rule evaluation classes and enums in GitHub API with new Bypass value

[HavenDV]

Summary by CodeRabbit

• New Features

  • Introduced a new evaluation outcome, Bypass, for more nuanced rule evaluations.
  • Added configuration options for enhanced secret scanning capabilities.

• Documentation

  • Updated documentation for various properties and methods to clarify functionality and usage.
  • Expanded OAuth scope requirements for certain API endpoints.

• Bug Fixes

  • Improved clarity regarding potential null values for evaluation results and details.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes involve updates to several classes and enums related to rule evaluations in the GitHub API. Key modifications include the addition of a new enumeration value, Bypass, to represent a new evaluation outcome, and enhancements to documentation comments for clarity. Additionally, updates were made to OAuth scope requirements and the handling of nullable fields in the OpenAPI specification, reflecting a broader range of possible states for rule evaluations and improved security configurations.

Changes

Files	Change Summary
src/libs/GitHub/Generated/GitHub.Models.RuleSuite2.g.cs	Modified documentation comment for Result property to clarify that it can be null if no rules were executed.
src/libs/GitHub/Generated/GitHub.Models.RuleSuiteEvaluationResult.g.cs, src/libs/GitHub/Generated/GitHub.Models.RuleSuiteEvaluationResult2.g.cs	Added Bypass enum value to represent a new evaluation outcome; updated ToValueString and FromValueString methods for string conversion.
src/libs/GitHub/Generated/GitHub.Models.RuleSuiteRuleEvaluation.g.cs	Modified documentation comment for Details property to specify it represents failure messages, indicating it can be null if the rule passed.
src/libs/GitHub/Generated/GitHub.OrgsClient.OrgsEnableOrDisableSecurityProductOnAllOrgRepos.g.cs	Updated documentation to deprecate previous functionality and clarify new OAuth scope requirements.
src/libs/GitHub/openapi.yaml	Expanded OAuth token requirements and updated evaluation result handling to include bypass and nullable fields for evaluation_result and details. Added secret_scanning_non_provider_patterns configuration.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant API
    participant RuleEvaluation

    User->>API: Request rule evaluation
    API->>RuleEvaluation: Execute rules
    RuleEvaluation->>API: Return evaluation result (pass/fail/bypass)
    API->>User: Send evaluation result

Loading

🐇 "In the land of code where changes bloom,
New paths are forged, dispelling gloom.
With Bypass added, rules now play,
A clearer dance in a brighter way.
OAuth scopes expanded, oh what a sight,
Security's enhanced, everything feels right!" 🐰✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  -- I pushed a fix in commit <commit_id>, please review it.
  -- Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  -- @coderabbitai generate unit testing code for this file.
  -- @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  -- @coderabbitai generate interesting stats about this repository and render them as a table.
  -- @coderabbitai read src/utils.ts and generate unit testing code.
  -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.