> ## Documentation Index > Fetch the complete documentation index at: https://docs.coderabbit.ai/llms.txt > Use this file to discover all available pages before exploring further. # Replace organization review configuration > Preserves organization-settings write permission, limits, audit, data-retention policy and optional revision checks. ## OpenAPI ````yaml /openapi.json put /v1/configuration/organization openapi: 3.0.3 info: title: CodeRabbit API spec version: 1.0.0 servers: - url: https://api.coderabbit.ai security: - ApiKeyAuth: [] paths: /v1/configuration/organization: put: tags: - Configuration summary: Replace organization review configuration description: >- Preserves organization-settings write permission, limits, audit, data-retention policy and optional revision checks. operationId: set_organization_configuration requestBody: required: true content: application/json: schema: type: object properties: org_id: type: string minLength: 1 description: >- Git-provider organization ID. Required for workspace keys; omit for organization keys. This differs from the CodeRabbit organization ID in scope.id. settings: type: object properties: language: enum: - de - de-DE - de-AT - de-CH - en - en-US - en-AU - en-GB - en-CA - en-NZ - en-ZA - es - es-AR - fr - fr-CA - fr-CH - fr-BE - nl - nl-BE - pt-AO - pt - pt-BR - pt-MZ - pt-PT - ar - ast-ES - ast - be-BY - be - br-FR - br - ca-ES - ca - ca-ES-valencia - ca-ES-balear - da-DK - da - de-DE-x-simple-language - el-GR - el - eo - fa - ga-IE - ga - gl-ES - gl - it - ja-JP - ja - km-KH - km - ko-KR - ko - pl-PL - pl - ro-RO - ro - ru-RU - ru - sk-SK - sk - sl-SI - sl - sv - ta-IN - ta - tl-PH - tl - tr - uk-UA - uk - zh-CN - zh - zh-TW - crh-UA - crh - cs-CZ - cs - nb - 'no' - nl-NL - de-DE-x-simple-language-DE - es-ES - it-IT - fa-IR - sv-SE - de-LU - fr-FR - bg-BG - bg - he-IL - he - hi-IN - hi - vi-VN - vi - th-TH - th - bn-BD - bn type: string default: en-US description: >- Set the language for reviews by using the corresponding ISO language code. tone_instructions: type: string maxLength: 250 default: '' description: >- Set the tone of reviews and chat. Example: 'You must talk like Mr. T. I pity the fool who doesn't!' early_access: type: boolean default: false description: Enable early-access features. enable_free_tier: type: boolean default: true description: Enable free tier features for users not on a paid plan. inheritance: type: boolean default: false description: >- Inheritance | Use parent settings for any values not defined here. Inheritance only propagates upward if enabled at each level. reviews: type: object properties: profile: enum: - quiet - chill - assertive type: string default: chill description: >- Set the review profile: quiet for only the most important feedback, chill for balanced feedback, assertive for more feedback (which may feel nitpicky). auto_approvals: type: object properties: enabled: type: boolean description: >- Automatic approvals | Request changes for blocking findings. Automatically approve when required threads are resolved, the latest commit is reviewed, pre-merge checks pass, and configured risk limits are satisfied. In GitLab, required discussions must be resolved. max_merge_risk: enum: - minimal - low - moderate - high - critical type: string description: >- Maximum merge risk for approval | Highest inclusive merge risk that permits approval. Omitted limits can be inherited; merge risk is unrestricted only when no configuration source sets a limit. A configured limit requires an assessment covering the current commit. allow_author_approval: type: boolean description: >- Allow author approval commands | Allow pull request authors to use top-level @coderabbitai approve and @coderabbitai resolve commands on their own pull requests. When disabled, another reviewer must run them. The pull request's branch configuration cannot re-enable this permission. Commands still honor approval risk limits. This does not require human review or change automatic approvals after normal review requirements pass. max_security_risk: enum: - minimal - low - moderate - high - critical type: string description: >- Maximum security risk for approval | Highest inclusive security architecture risk that permits approval. Security risk assessments require the Advanced plan or above. Omitted limits can be inherited; security risk is unrestricted only when no configuration source sets a limit. This is separate from Security finding severity. A configured limit requires an assessment covering the current commit. overrides: type: array items: type: object properties: enabled: description: >- Automatic approvals | Set to false to withhold approval for matching pull requests, regardless of risk. Omit to use the global setting. Any matching disabled override wins. Review comments and requests for changes continue normally; overrides cannot turn on a globally disabled workflow. enum: - false teams: type: array minItems: 1 maxItems: 15 items: type: string pattern: >- ^[A-Za-z0-9][A-Za-z0-9-]*\/[A-Za-z0-9][A-Za-z0-9-]*$ description: >- Teams | Apply this override when the pull request author belongs to any listed GitHub team. Use organization/team-slug. paths: type: array minItems: 1 items: type: string minLength: 1 description: >- Paths | Apply this override when any changed file matches these repository-relative globs. Uses the same glob syntax as `path_filters`, including ! exclusions. Renames match both old and new paths. When teams and paths are set, both must match. Omit to match all paths. max_merge_risk: enum: - minimal - low - moderate - high - critical type: string description: >- Maximum merge risk for approval | Override the global merge-risk limit for matching pull requests. Omit to inherit the global limit. max_security_risk: enum: - minimal - low - moderate - high - critical type: string description: >- Maximum security risk for approval | Override the global security-risk limit for matching pull requests. Omit to inherit the global limit. Security risk assessments require the Advanced plan or above. additionalProperties: false description: >- Overrides | Disable approvals or override risk limits by author team, changed paths, or both. When teams and paths are set, both must match. A matching file applies the override to the whole pull request. Any matching disabled override withholds approval. Otherwise, the strictest explicitly configured value wins for each limit; omitted values inherit the global limit. At most 15 distinct teams may be checked. Unavailable required team membership or changed-file evidence withholds approval. additionalProperties: false default: {} description: >- Automatic approvals | Control automatic approval, optional risk limits, and overrides for teams or paths. Limits and disabled overrides apply to approve and resolve commands too. Missing, failed, disabled or stale required assessments withhold approval. merge_risk_instructions: type: string maxLength: 3000 description: >- Merge Risk Instructions | Describe what makes a pull request more or less risky to merge in this codebase. CodeRabbit uses this when rating merge risk, which `auto_approvals.max_merge_risk` can limit for automatic approval. Up to 3000 characters. Example: `Database migrations and billing changes are high risk. Docs-only and test-only changes are low risk.` security_risk_instructions: type: string maxLength: 3000 description: >- Security Risk Instructions | Describe facts about your system that affect security risk, such as which services are internet-facing, where tenant isolation is enforced, or which controls protect a path. CodeRabbit uses this when rating security architecture risk, which `auto_approvals.max_security_risk` can limit for automatic approval. Security risk assessments require the Advanced plan or above. Unlike Security scan context, which guides security findings in reviews and scans, this only affects the risk rating. Up to 3000 characters. Example: `The admin service is reachable only over the corporate VPN. Changes to tenant isolation in packages/tenancy are high risk.` request_changes_workflow: type: boolean description: Legacy alias for reviews.auto_approvals.enabled. allow_author_approval: type: boolean description: >- Legacy alias for reviews.auto_approvals.allow_author_approval. high_level_summary: type: boolean default: true description: >- Generate a high-level summary of the changes in the PR description or walkthrough. high_level_summary_instructions: type: string default: '' description: >- By default, CodeRabbit generates release notes in the description. Use this to customize the summary content and format. Example: 'Create concise release notes as a bullet-point list, followed by a Markdown table showing lines added and removed by each contributing author.' Note: Use `high_level_summary_in_walkthrough` to place the summary in the walkthrough instead of the description. high_level_summary_placeholder: type: string default: '@coderabbitai summary' description: >- Placeholder in the PR description that CodeRabbit replaces with the high-level summary. If `high_level_summary` is false, the summary is still generated when this placeholder is present. high_level_summary_in_walkthrough: type: boolean default: false description: >- Include the high-level summary in the walkthrough comment. auto_title_placeholder: type: string default: '@coderabbitai' description: >- Add this keyword to the PR title to auto-generate a title. auto_title_instructions: type: string default: '' description: >- Auto Title Instructions | Customize how CodeRabbit generates the PR title. review_status: type: boolean default: true description: >- Post review status messages (e.g., when a review is skipped) in the walkthrough summary comment. review_info: type: boolean default: true description: >- Post review information such as the configuration used, reviewed commits, and skipped files. review_details: type: boolean default: false description: >- Post review details (ignored files, extra context used, suppressed comments, etc.). review_progress: type: boolean default: true description: >- On GitHub with CodeRabbit Cloud, report each review as a check run named `CodeRabbit` that shows the review's progress and outcome. When disabled, CodeRabbit posts the `CodeRabbit` commit status instead, if `commit_status` is enabled. GitLab, Azure DevOps, Bitbucket, and self-hosted CodeRabbit use the commit status. commit_status: type: boolean default: true description: >- Post a commit status named `CodeRabbit` on the pull request's latest commit. It is pending while CodeRabbit reviews and turns successful when the review ends, including when it is skipped or rate limited. Used on GitLab, Azure DevOps, Bitbucket, and self-hosted CodeRabbit, and on GitHub when `review_progress` is disabled. Require it in branch protection to keep pull requests from merging while a review is in progress. fail_commit_status: type: boolean default: false description: >- Report a review that stops because of an error as failed, so a required `CodeRabbit` check blocks merging. When disabled, the GitHub check run ends as neutral and the commit status ends as successful, with the error in its description. Rate-limited reviews never fail. collapse_walkthrough: type: boolean default: true description: >- Wrap the walkthrough in a Markdown collapsible section. changed_files_summary: type: boolean default: true description: >- Include a summary of the changed files in the walkthrough. sequence_diagrams: type: boolean default: true description: Include sequence diagrams in the walkthrough. estimate_code_review_effort: type: boolean default: true description: >- Include an estimated code review effort in the walkthrough. assess_linked_issues: type: boolean default: true description: >- Include an assessment of how well the changes address linked issues in the walkthrough. related_issues: type: boolean default: true description: >- Include potentially related issues in the walkthrough. related_prs: type: boolean default: true description: >- Related PRs | Include potentially related PRs in the walkthrough. suggested_labels: type: boolean default: true description: >- Suggest labels based on the changes, and include them in the walkthrough. labeling_instructions: type: array items: type: object properties: label: type: string description: 'Label to suggest for the PR. Example: frontend' instructions: type: string maxLength: 3000 description: >- Instructions for the label. Example: Apply when the PR contains changes to React components. required: - label - instructions default: [] description: >- Labeling Instructions | Define allowed labels and when to suggest them. When provided, CodeRabbit suggests only from this list (still informed by prior PRs); when empty, suggestions rely entirely on prior PRs. mutually_exclusive_groups: type: object additionalProperties: type: array minItems: 2 items: type: string minLength: 1 default: {} description: >- Mutually Exclusive Groups | Define labels that should not coexist. Example: `{ risk: ['critical', 'high', 'medium', 'low'] }`. Property names must contain at least 1 character. x-propertyNames: type: string minLength: 1 auto_apply_labels: type: boolean default: false description: Automatically apply suggested labels to the PR. suggested_reviewers: type: boolean default: true description: >- Suggest reviewers based on the changes, and include them in the walkthrough. auto_assign_reviewers: type: boolean default: false description: >- Automatically assign the suggested reviewers to the PR. suggested_reviewers_instructions: type: array items: type: object properties: reviewers: type: array minItems: 1 items: type: object properties: handle: type: string minLength: 1 description: >- Reviewer username or team slug to assign. Example: security-pdl type: enum: - user - group type: string default: user description: >- Whether the reviewer is an individual user or a team/group. required: - handle description: >- List of reviewers to assign when the PR matches the instructions below. Each entry pairs a handle (username or team slug) with its type (user or group). instructions: type: string minLength: 1 maxLength: 3000 description: >- Instructions for when to assign these reviewers. Example: Assign when the PR contains Windows registry changes. required: - reviewers - instructions default: [] description: >- Reviewer Instructions | Map reviewers (users or team) to PR scenarios where they should be assigned. When empty, suggestions rely on prior PRs. Team handles are supported only on GitHub. in_progress_fortune: type: boolean default: true description: Post a fortune message while the review is running. poem: type: boolean default: false description: Generate a poem in the walkthrough comment. enable_prompt_for_ai_agents: type: boolean default: true description: >- Prompt for Coding Agents | Include the '🤖 Prompt for Coding Agents' section in inline review comments to provide codegen instructions for AI agents. path_filters: type: array items: type: string default: [] description: >- Specify file patterns to include or exclude in a review using glob patterns (e.g., `!dist/**`, `src/**`). These patterns also apply to 'git sparse-checkout', including specified patterns and ignoring excluded ones (starting with '!') when cloning the repository. path_instructions: type: array items: type: object properties: path: type: string description: 'File path glob pattern. Example: `**/*.js`.' instructions: type: string maxLength: 20000 description: Additional review guidance for matching paths. required: - path - instructions default: [] description: >- Path Instructions | Add path-specific guidance for code review. abort_on_close: type: boolean default: true description: >- Abort the in-progress review if the PR is closed or merged. disable_cache: type: boolean default: false description: >- Disable caching of code and dependencies; fetch them fresh on each run. slop_detection: type: object properties: enabled: type: boolean default: true description: >- Enable or disable slop and low-quality PR detection. include_all_authors: type: boolean default: false description: >- Run slop detection for all PR authors, including collaborators, contributors, organization members, and repository owners. label: type: string minLength: 1 description: >- Label to apply to the PR when it is classified as slop. Example: slop default: {} description: >- Anti-Slop | Settings for detecting and managing spam or low-quality PRs on GitHub. Available for public repositories on all plans and private repositories on the Essentials plan and above. auto_review: type: object properties: enabled: type: boolean default: true description: Automatic Review | Review PRs automatically. description_keyword: type: string default: '' description: >- Keyword in the PR description that triggers a review when automatic reviews are disabled. If `enabled` is false and this field is not empty, CodeRabbit reviews the PR only when this keyword is present in the description. auto_incremental_review: type: boolean default: true description: >- Incremental Review | Re-run the review on each push. auto_pause_after_reviewed_commits: type: integer minimum: 0 maximum: 9007199254740991 default: 5 description: >- Auto Pause After Reviewed Commits | Pause automatic reviews after this many reviewed commits since the last pause. Set to 0 to disable. ignore_title_keywords: type: array items: type: string default: [] description: >- Skip reviews when the PR title contains any of these keywords (case-insensitive). labels: type: array items: type: string default: [] description: >- Labels that control which PRs are reviewed. Labels starting with '!' are negative matches. Examples: ['bug', 'feature'] reviews PRs with either label. ['!wip'] reviews all PRs except those labeled 'wip' when automatic reviews are enabled. ['bug', '!wip'] reviews PRs labeled 'bug' but not 'wip'. When `enabled` is false, a positive label match (for example ['review-ready']) triggers a review; negative-only labels such as ['!wip'] remain exclusion filters and do not opt PRs in by themselves. drafts: type: boolean default: false description: Include draft PRs. base_branches: type: array items: type: string default: [] description: >- Base branches (other than the default branch) to review. Accepts regex patterns. Use '.*' to match all branches. ignore_usernames: type: array items: type: string default: [] description: >- Skip reviews for PRs authored by these usernames (exact match; not email addresses). default: {} finishing_touches: type: object properties: docstrings: type: object properties: enabled: type: boolean default: true description: >- Docstrings | Enable the docstrings finishing touch (trigger via the 📝 Generate docstrings checkbox or `@coderabbitai generate docstrings`). CodeRabbit generates or improves docstrings for functions changed in the PR and opens a follow-up PR containing the docstring edits. default: {} description: Docstrings | Configure docstring generation. unit_tests: type: object properties: enabled: type: boolean default: true description: >- Unit Tests | Generate unit tests for changes in PRs. default: {} description: Unit Tests | Configure unit test generation. simplify: type: object properties: enabled: type: boolean default: false description: >- Simplify | Enable the simplify finishing touch (trigger via the ✨ Simplify code checkbox). CodeRabbit reviews changed code for reuse, quality, and efficiency, then applies targeted improvements. default: {} description: Simplify | Configure code simplification. autofix: type: object properties: enabled: type: boolean default: true description: >- Fix comments | Enable the Fix comments finishing touch (trigger via the 🪄 Fix comments checkbox under review comments or the `@coderabbitai fix comments` command). When disabled, the Fix comments checkboxes are hidden, the command is removed from help, and CodeRabbit declines one-off repair requests using `@coderabbitai fix comments` or the compatibility aliases `fix-comments`, `fix`, `autofix`, `auto-fix`, and `auto fix`, with or without `stacked pr`. default: {} description: >- Fix comments | Configure the Fix comments finishing touch. fix_ci: type: object properties: enabled: type: boolean default: true description: >- Fix Failing CI | Enable the fix-ci finishing touch on GitHub and Azure DevOps; requires a Team plan. When CI failures are attributed to the current pull request, Finishing Touches offers the delivery modes supported by the repository. Where both modes are available, it offers mutually exclusive stacked-pull-request and direct-commit options; where stacked-pull-request delivery is unavailable but direct commits are supported, it offers direct commit only. The `@coderabbitai fix-ci` command requests a stacked pull request by default, but commits in place on a CodeRabbit-authored pull request to avoid creating another stacked pull request. Use `@coderabbitai fix-ci commit` to request a direct commit. When disabled, both commands are removed from help and CodeRabbit declines fix-ci requests. default: {} description: Fix Failing CI | Configure the CI fixer. resolve_merge_conflict: type: object properties: enabled: type: boolean default: true description: >- Resolve Merge Conflicts | Enable the merge-conflict resolver (trigger via `@coderabbitai resolve merge conflict`). CodeRabbit analyzes the intent behind both sides of a conflict and commits a resolution to your branch. When disabled, the command is removed from help and CodeRabbit declines resolution requests. Available on GitHub and GitLab; requires a Team plan. default: {} description: >- Resolve Merge Conflicts | Configure the merge-conflict resolver. custom: type: array maxItems: 20 items: type: object properties: enabled: type: boolean default: true description: >- Enabled | Enable this custom finishing touch recipe. name: type: string minLength: 1 maxLength: 100 default: '' description: >- Name | Recipe name used in commands (for example: `@coderabbitai run cleanup stale imports`). Run with `@coderabbitai run `. instructions: type: string minLength: 1 maxLength: 10000 default: '' description: >- Instructions | Describe what this recipe should do. Trigger with `@coderabbitai run ` or the checkbox under "✨ Finishing Touches". CodeRabbit provides PR context and runs this with an agent. default: [] description: >- Custom Recipes | Define custom finishing touch recipes up to your plan limit. Trigger a recipe with `@coderabbitai run `. default: {} pre_merge_checks: type: object properties: override_requested_reviewers_only: type: boolean default: false description: >- Override Requested Reviewers Only | When enabled, the pull request author cannot override/ignore failing pre-merge checks. Eligible actors are individually requested reviewers and, on GitHub, members of requested reviewer teams or submitted reviewers whose author association is OWNER, MEMBER, or COLLABORATOR. docstrings: type: object properties: mode: enum: - 'off' - warning - error type: string default: warning description: >- Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes. threshold: type: number minimum: 0 maximum: 100 default: 80 description: >- Threshold | Minimum docstring coverage (%) required to pass. default: {} description: >- Docstring Coverage | Check that docstring coverage meets the configured threshold. title: type: object properties: mode: enum: - 'off' - warning - error type: string default: warning description: >- Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes. requirements: type: string default: '' description: >- Requirements | Describe title requirements. Example: 'Title should be concise and descriptive, ideally under 50 characters.' default: {} description: >- Title Check | Validate the PR title against the requirements. description: type: object properties: mode: enum: - 'off' - warning - error type: string default: warning description: >- Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes. default: {} description: >- Description Check | Check that the PR description follows best practices. issue_assessment: type: object properties: mode: enum: - 'off' - warning - error type: string default: warning description: >- Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes. default: {} description: >- Linked Issue Assessment | Assess how well the PR addresses linked issues. custom_checks: type: array maxItems: 50 items: type: object properties: mode: enum: - 'off' - warning - error type: string default: warning description: >- Mode | Enforcement level: `off` disables the check, `warning` posts a warning, and `error` requires resolution before merging. If the request-changes workflow is enabled, `error` can block the PR until the check passes. name: type: string minLength: 1 maxLength: 50 default: '' description: Name | Display name (max 50 characters). instructions: type: string minLength: 1 maxLength: 10000 default: '' description: >- Instructions | Deterministic pass/fail criteria (max 10,000 characters). default: [] description: >- Custom Pre-merge Checks | Define custom checks that must pass before merging. Each check needs a unique name (≤50 chars) and deterministic instructions (≤10,000 chars). default: {} post_merge_actions: type: array maxItems: 5 items: type: object properties: enabled: type: boolean default: true description: >- Enabled | Run this action after a PR is merged. name: type: string minLength: 1 maxLength: 100 default: '' description: Name | Display name (max 100 characters). prompt: type: string minLength: 1 maxLength: 10000 default: '' description: >- Prompt | Deterministic instructions describing the action to perform (max 10,000 characters). default: [] description: >- Custom Post-merge Actions | Define custom actions to run after merging. Each action needs a unique name (≤100 chars) and a deterministic prompt (≤10,000 chars). tools: type: object properties: ast-grep: type: object properties: enabled: type: boolean default: true description: >- Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.51.1 rule_dirs: type: array items: type: string default: [] description: List of rules directories. util_dirs: type: array items: type: string default: [] description: List of utils directories. essential_rules: type: boolean default: true description: Use ast-grep essentials package. packages: type: array items: type: string default: [] description: Predefined packages to be used. default: {} description: >- Enable ast-grep | ast-grep is a code analysis tool that helps you to find patterns in your codebase using abstract syntax trees patterns. | v0.51.1 shellcheck: type: object properties: enabled: type: boolean default: true description: >- Enable ShellCheck | ShellCheck is a static analysis tool that finds bugs in your shell. | Enable ShellCheck integration. | v0.11.0 default: {} description: >- ShellCheck is a static analysis tool that finds bugs in your shell scripts. ruff: type: object properties: enabled: type: boolean default: true description: >- Enable Ruff | Ruff is a Python linter and code formatter. | Enable Ruff integration. | v0.17.1 config_file: type: string description: >- Optional path to a Ruff configuration file relative to the repository. When set, this configuration is used for every reviewed file instead of Ruff's closest-config discovery. default: {} description: Ruff is a Python linter and code formatter. markdownlint: type: object properties: enabled: type: boolean default: true description: >- Enable markdownlint | markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. | Enable markdownlint integration. | v0.23.3 default: {} description: >- markdownlint-cli2 is a static analysis tool to enforce standards and consistency for Markdown files. github-checks: type: object properties: enabled: type: boolean default: true description: "Enable GitHub Checks\n\t\t\t| Enable integration, defaults to true\n\t\t\t| Enable GitHub Checks integration." default: {} description: GitHub Checks integration configuration. languagetool: type: object properties: enabled: type: boolean default: true description: >- Enable LanguageTool | Enable LanguageTool integration. enabled_rules: type: array items: type: string default: [] description: >- IDs of rules to be enabled. The rule won't run unless 'level' is set to a level that activates the rule. disabled_rules: type: array items: type: string default: [] description: >- IDs of rules to be disabled. Note: EN_UNPAIRED_BRACKETS, and EN_UNPAIRED_QUOTES are always disabled. enabled_categories: type: array items: type: string default: [] description: IDs of categories to be enabled. disabled_categories: type: array items: type: string default: [] description: >- IDs of categories to be disabled. Note: TYPOS, TYPOGRAPHY, and CASING are always disabled. enabled_only: type: boolean default: false description: >- Only the rules and categories whose IDs are specified with 'enabledRules' or 'enabledCategories' are enabled. level: enum: - default - picky type: string default: default description: >- If set to 'picky', additional rules will be activated, i.e. rules that you might only find useful when checking formal text. default: {} description: >- LanguageTool is a style and grammar checker for 30+ languages. biome: type: object properties: enabled: type: boolean default: true description: >- Enable Biome | Biome is a fast formatter, linter, and analyzer for web projects. | Enable Biome integration. | v2.5.15 default: {} description: >- Biome is a fast formatter, linter, and analyzer for web projects. hadolint: type: object properties: enabled: type: boolean default: true description: >- Enable Hadolint | Hadolint is a Dockerfile linter. | Enable Hadolint integration. | v2.15.1 default: {} description: Hadolint is a Dockerfile linter. swiftlint: type: object properties: enabled: type: boolean default: true description: >- Enable SwiftLint | SwiftLint is a Swift linter. | Enable SwiftLint integration. | v0.65.1 config_file: type: string description: >- Optional path to the SwiftLint configuration file relative to the repository. This is useful when the configuration file is named differently than the default '.swiftlint.yml' or '.swiftlint.yaml'. default: {} description: SwiftLint integration configuration object. phpstan: type: object properties: enabled: type: boolean default: true description: >- Enable PHPStan | PHPStan requires [config file](https://phpstan.org/config-reference#config-file) in your repository root. Please ensure that this file contains the `paths:` parameter. | v2.3.1 level: enum: - '0' - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' - default - max type: string default: default description: >- Level | Specify the [rule level](https://phpstan.org/user-guide/rule-levels) to run. When set to `default`, the level is determined by the review profile: `chill` uses level 3 (real bugs only — return/property type mismatches, array offset errors) and `assertive` uses level 8 (adds dead code detection, argument type checking, null safety, and typehint checks). This setting is ignored if your configuration file already has a `level:` parameter. default: {} description: PHPStan is a tool to analyze PHP code. phpmd: type: object properties: enabled: type: boolean default: true description: >- Enable PHPMD | PHPMD is a tool to find potential problems in PHP code. | v3.0.0 default: {} description: >- PHPMD is a tool to find potential problems in PHP code. phpcs: type: object properties: enabled: type: boolean default: true description: >- Enable PHP CodeSniffer | PHP CodeSniffer is a PHP linter and coding standard checker. | v3.13.6 default: {} description: >- PHP CodeSniffer is a PHP linter and coding standard checker. golangci-lint: type: object properties: enabled: type: boolean default: true description: >- Enable golangci-lint | golangci-lint is a fast linters runner for Go. | Enable golangci-lint integration. | v2.15.0 config_file: type: string description: >- Optional path to the golangci-lint configuration file relative to the repository. Useful when the configuration file is named differently than the default '.golangci.yml', '.golangci.yaml', '.golangci.toml', '.golangci.json'. default: {} description: golangci-lint is a fast linters runner for Go. yamllint: type: object properties: enabled: type: boolean default: true description: >- Enable YAMLlint | YAMLlint is a linter for YAML files. | Enable YAMLlint integration. | v1.37.1 default: {} description: YAMLlint is a linter for YAML files. gitleaks: type: object properties: enabled: type: boolean default: true description: >- Enable Betterleaks | Betterleaks is a secret scanner (an improved version of Gitleaks). | Enable Betterleaks integration. | v1.9.0 default: {} description: >- Betterleaks is a secret scanner (an improved version of Gitleaks). trufflehog: type: object properties: enabled: type: boolean default: true description: >- Enable TruffleHog | TruffleHog is a secret scanner with verification capabilities. | Enable TruffleHog integration. | v3.96.0 default: {} description: >- TruffleHog is a secret scanner with verification capabilities that can detect and verify secrets in code. checkov: type: object properties: enabled: type: boolean default: true description: >- Enable Checkov | Checkov is a static code analysis tool for infrastructure-as-code files. | v3.3.30 default: {} description: >- Checkov is a static code analysis tool for infrastructure-as-code files. tflint: type: object properties: enabled: type: boolean default: true description: >- Enable TFLint | TFLint is a Terraform linter for finding potential errors. | v0.64.0 default: {} description: >- TFLint is a Terraform linter for finding potential errors and enforcing best practices. detekt: type: object properties: enabled: type: boolean default: true description: >- Enable detekt | detekt is a static code analysis tool for Kotlin files. | v1.23.8 config_file: type: string description: >- Optional path to the detekt configuration file relative to the repository. default: {} description: >- Detekt is a static code analysis tool for Kotlin files. eslint: type: object properties: enabled: type: boolean default: true description: >- Enable ESLint | ESLint is a static code analysis tool for JavaScript files. config_file: type: string description: >- Optional path to an ESLint configuration file relative to the repository. When set, this configuration is used for every file instead of discovering ESLint configurations recursively. e18e: type: object properties: enabled: type: boolean default: true description: >- Enable @e18e/eslint-plugin | Detects dependencies with modern replacements, flags unmaintained packages, and suggests native API alternatives or lighter replacements | v0.8.1 default: {} description: >- @e18e/eslint-plugin modernization, performance, and dependency replacement checks. default: {} description: >- ESLint is a static code analysis tool for JavaScript files. flake8: type: object properties: enabled: type: boolean default: true description: >- Enable Flake8 | Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script. | v7.4.1 default: {} description: >- Flake8 is a Python linter that wraps PyFlakes, pycodestyle and Ned Batchelder's McCabe script. fbinfer: type: object properties: enabled: type: boolean default: true description: >- Enable Infer for static bug analysis in Java and C/C++ code | v1.3.0 enable_java: type: boolean default: false description: >- Enable Java analysis | Disabled by default because Java analysis may require compiling more than the changed files. default: {} description: >- Configuration for Infer to find bugs in Java and C/C++ code fortitudeLint: type: object properties: enabled: type: boolean default: true description: >- Enable Fortitude | Fortitude is a Fortran linter that checks for code quality and style issues | v0.9.2 default: {} description: >- Fortitude is a Fortran linter that checks for code quality and style issues. rubocop: type: object properties: enabled: type: boolean default: true description: >- Enable RuboCop | RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. | v1.92.0 default: {} description: >- RuboCop is a Ruby static code analyzer (a.k.a. linter ) and code formatter. buf: type: object properties: enabled: type: boolean default: true description: >- Enable Buf | Buf offers linting for Protobuf files. | v1.74.0 default: {} description: Buf offers linting for Protobuf files. regal: type: object properties: enabled: type: boolean default: true description: >- Enable Regal | Regal is a linter and language server for Rego. | v0.43.0 default: {} description: Regal is a linter and language server for Rego. actionlint: type: object properties: enabled: type: boolean default: true description: >- Enable actionlint | actionlint is a static checker for GitHub Actions workflow files. | v1.7.12 default: {} description: >- actionlint is a static checker for GitHub Actions workflow files. zizmor: type: object properties: enabled: type: boolean default: true description: >- Enable zizmor | zizmor is a static security analyzer for GitHub Actions workflow files. | v1.31.1 default: {} description: >- zizmor is a static security analyzer for GitHub Actions workflow files. pmd: type: object properties: enabled: type: boolean default: true description: >- Enable PMD | PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. | v7.28.0 config_file: type: string description: >- Optional path to the PMD configuration file relative to the repository. default: {} description: >- PMD is an extensible multilanguage static code analyzer. It’s mainly concerned with Java. clang: type: object properties: enabled: type: boolean default: true description: >- Enable Clang for C/C++ static analysis and code quality checks | v23.1.4 default: {} description: >- Configuration for Clang to perform static analysis on C and C++ code cppcheck: type: object properties: enabled: type: boolean default: true description: >- Enable Cppcheck | Cppcheck is a static code analysis tool for the C and C++ programming languages. | v2.22.0 default: {} description: >- Cppcheck is a static code analysis tool for the C and C++ programming languages. vale: type: object properties: enabled: type: boolean default: true description: >- Enable Vale | Vale checks prose against repository-defined editorial style rules. It runs only when a supported root Vale configuration is present. | v3.24.0 default: {} description: >- Vale lints prose using the repository's checked-in style rules. verilator: type: object properties: enabled: type: boolean default: true description: >- Enable Verilator | Verilator lints Verilog and SystemVerilog for syntax, width, connectivity, and behavioral correctness issues. | v5.052 default: {} description: >- Verilator statically analyzes Verilog and SystemVerilog source files. opengrep: type: object properties: enabled: type: boolean default: true description: >- Enable OpenGrep | OpenGrep is a high-performance static code analysis engine for finding security vulnerabilities and bugs across 17+ languages. | v1.31.0 default: {} description: >- OpenGrep is a high-performance static code analysis engine, compatible with Semgrep configurations. semgrep: type: object properties: enabled: type: boolean default: true description: >- Enable Semgrep | Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. | Enable Semgrep integration. | v1.183.0 config_file: type: string description: >- Optional path to the Semgrep configuration file relative to the repository. default: {} description: >- Semgrep is a static analysis tool designed to scan code for security vulnerabilities and code quality issues. circleci: type: object properties: enabled: type: boolean default: true description: >- Enable CircleCI | CircleCI tool is a static checker for CircleCI config files. | v1.9.0 default: {} description: >- CircleCI tool is a static checker for CircleCI config files. clippy: type: object properties: enabled: type: boolean default: true description: >- Enable Clippy | Clippy is a collection of lints to catch common mistakes and improve your Rust code. | Enable Clippy integration. default: {} description: >- Clippy is a collection of lints to catch common mistakes and improve your Rust code. sqlfluff: type: object properties: enabled: type: boolean default: true description: >- Enable SQLFluff | SQLFluff is an open source, dialect-flexible and configurable SQL linter. | v4.4.0 config_file: type: string description: >- Optional path to the SQLFluff configuration file relative to the repository. Use this when the config file is not named one of SQLFluff's default filenames. default: {} description: >- SQLFluff is an open source, dialect-flexible and configurable SQL linter. squawk: type: object properties: enabled: type: boolean default: true description: >- Enable Squawk for Postgres migration linting | Detects unsafe schema changes that can cause downtime or blocking locks | v2.70.0 default: {} description: >- Configuration for Squawk to lint Postgres migrations and SQL for safe schema changes trivy: type: object properties: enabled: type: boolean default: true description: >- Enable Trivy for security scanning of IaC files (Terraform, Kubernetes, Docker, etc.) | v0.76.0 default: {} description: >- Trivy is a comprehensive security scanner that detects misconfigurations and secrets in Infrastructure as Code files prismaLint: type: object properties: enabled: type: boolean default: true description: >- Enable Prisma Schema linting | Prisma Schema linting helps maintain consistent and error-free schema files | v0.13.1 default: {} description: >- Configuration for Prisma Schema linting to ensure schema file quality pylint: type: object properties: enabled: type: boolean default: true description: >- Enable Pylint | Pylint is a Python static code analysis tool. | v4.1.3 default: {} description: Pylint is a Python static code analysis tool. oxc: type: object properties: enabled: type: boolean default: true description: >- Enable Oxlint | Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. | v1.89.0 default: {} description: >- Oxlint is a JavaScript/TypeScript linter for OXC written in Rust. shopifyThemeCheck: type: object properties: enabled: type: boolean default: true description: >- Enable Shopify Theme Check | A linter for Shopify themes that helps you follow Shopify theme & Liquid best practices | cli 4.9.4 | theme 3.58.2 default: {} description: >- Configuration for Shopify Theme Check to ensure theme quality and best practices luacheck: type: object properties: enabled: type: boolean default: true description: >- Enable Lua code linting | Luacheck helps maintain consistent and error-free Lua code | v1.2.0 default: {} description: >- Configuration for Lua code linting to ensure code quality brakeman: type: object properties: enabled: type: boolean default: true description: >- Enable Brakeman | Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v8.1.0 default: {} description: >- Brakeman is a static analysis security vulnerability scanner for Ruby on Rails applications. | v8.1.0 dotenvLint: type: object properties: enabled: type: boolean default: true description: >- Enable dotenv-linter | dotenv-linter is a tool for checking and fixing .env files for problems and best practices | v4.0.0 default: {} description: >- dotenv-linter is a tool for checking and fixing .env files for problems and best practices htmlhint: type: object properties: enabled: type: boolean default: true description: >- Enable HTMLHint | HTMLHint is a static code analysis tool for HTML files. | Enable HTMLHint integration. | v1.9.2 additionalProperties: false description: >- HTMLHint is a static code analysis tool for HTML files. default: {} stylelint: type: object properties: enabled: type: boolean default: true description: >- Enable Stylelint | Stylelint is a linter for stylesheets (CSS, SCSS, Sass, Less, SugarSS, Stylus) that helps avoid errors and enforce conventions. | Enable Stylelint integration. | v17.14.0 additionalProperties: false description: >- Stylelint is a linter for stylesheets (CSS, SCSS, Sass, Less, SugarSS, Stylus) that helps avoid errors and enforce conventions. default: {} checkmake: type: object properties: enabled: type: boolean default: true description: >- Enable checkmake | checkmake is a linter for Makefiles. | v0.3.2 default: {} description: checkmake is a linter for Makefiles. osvScanner: type: object properties: enabled: type: boolean default: true description: >- Enable OSV Scanner | OSV Scanner is a tool for vulnerability package scanning | v2.7.0 default: {} description: >- OSV Scanner is a tool for vulnerability package scanning. oasdiff: type: object properties: enabled: type: boolean default: true description: >- Enable oasdiff | oasdiff detects breaking changes between OpenAPI specifications. | v1.34.0 default: {} description: >- oasdiff detects breaking changes between OpenAPI specifications. reactDoctor: type: object properties: enabled: type: boolean default: true description: >- Enable React Doctor | React Doctor scans React codebases for security, performance, correctness, and accessibility issues. | v0.9.18 default: {} description: >- React Doctor scans React codebases for security, performance, correctness, and accessibility issues. presidio: type: object properties: enabled: type: boolean default: true description: >- Enable Microsoft Presidio Analyzer for high-signal PII in changed files | v2.2.364 default: {} description: >- Microsoft Presidio Analyzer 2.2.364 detects sensitive identifiers (including payment cards, US SSN, cryptocurrency wallets, and phone numbers) in changed files. Tune entities, thresholds, and languages in repository Presidio configuration (for example .presidiocli or AnalyzerEngineProvider YAML); the built-in scan uses fixed defaults and is skipped when that configuration is present. blinter: type: object properties: enabled: type: boolean default: true description: >- Enable Blinter | Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems. | v1.1.43 default: {} description: >- Blinter is a linter for Windows batch files that provides comprehensive static analysis to identify syntax errors, security vulnerabilities, performance issues, and style problems. smartyLint: type: object properties: enabled: type: boolean default: true description: >- Enable smarty-lint | smarty-lint is a linter for Smarty 3 template files that checks for common issues such as incorrect operator usage, naming conventions, empty blocks, and unquoted strings. | v0.3.3 default: {} description: >- smarty-lint is a linter for Smarty 3 template files that checks for common issues such as incorrect operator usage, naming conventions, empty blocks, and unquoted strings. emberTemplateLint: type: object properties: enabled: type: boolean default: true description: >- Enable ember-template-lint | ember-template-lint is a linter for Handlebars template files that checks for common issues such as accessibility violations, deprecated patterns, and template anti-patterns. | v7.9.4 default: {} description: >- ember-template-lint is a linter for Handlebars template files that checks for common issues such as accessibility violations, deprecated patterns, and template anti-patterns. skillspector: type: object properties: enabled: type: boolean default: true description: >- Enable SkillSpector | SkillSpector is a security scanner for AI agent skills. It detects vulnerabilities, malicious patterns, and security risks in SKILL.md manifests and MCP configurations. | v2.12.0 default: {} description: >- SkillSpector is a security scanner for AI agent skills that detects vulnerabilities, malicious patterns, and security risks psscriptanalyzer: type: object properties: enabled: type: boolean default: true description: >- Enable PSScriptAnalyzer | PSScriptAnalyzer is a static code checker for PowerShell scripts and modules. | v1.25.0 default: {} description: >- PSScriptAnalyzer is a static code checker for PowerShell scripts and modules. description: >- Tools that provide additional context to code reviews. default: {} description: Settings related to reviews. default: {} chat: type: object properties: art: type: boolean default: true description: Generate art in chat responses (ASCII or emoji). allow_non_org_members: type: boolean default: true description: >- Allow non-organization members to interact with CodeRabbit in comment chat. Set to false to restrict issue/review comment interactions to organization members on GitHub organization repositories. This does not affect automatic PR review eligibility. auto_reply: type: boolean default: true description: >- Let CodeRabbit reply automatically without requiring a mention/tag. integrations: type: object properties: jira: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Jira | Allow creating Jira issues from chat. 'auto' disables the integration for public repositories. issue_template: type: string maxLength: 3000 default: '' description: >- Jira Issue Template | Structure to use for the description of Jira issues created from chat. Provide the headings your team expects, one per line, for example '## Goal', '## Description', '## Acceptance Criteria'. Leave empty to let CodeRabbit choose the structure. default: {} linear: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Linear | Allow creating Linear issues from chat. 'auto' disables the integration for public repositories. default: {} default: {} default: {} knowledge_base: type: object properties: opt_out: type: boolean default: false description: >- Opt Out | Disable knowledge base features that require data retention. Opting out removes any existing stored knowledge base data. web_search: type: object properties: enabled: type: boolean default: true description: >- Web Search | Use web search to gather additional context. default: {} code_guidelines: type: object properties: enabled: type: boolean default: true description: >- Enabled | Apply your organization's coding standards during reviews. filePatterns: type: array items: anyOf: - type: string - type: object properties: files: type: string description: >- Files | Comma-separated glob patterns for guideline files (e.g., `**/AGENTS.md`). Multiple patterns supported. File names are case-sensitive. applyTo: type: string description: >- Apply To | Comma-separated glob patterns for files these guidelines applies to (e.g., `**/*.ts`). Multiple patterns supported. File names are case-sensitive. required: - files - applyTo default: [] description: >- File Patterns | Patterns for your coding guideline documents. CodeRabbit scans these files to learn your standards and apply them during reviews. Multiple files supported; file names are case-sensitive. An entry may also reference another repository the CodeRabbit installation can read, as repo:path or owner/repo:path (e.g. engineering-standards:frontend/react.md, globs supported); such files are read at that repository's default branch. A bare repo name uses the reviewed repository's owner. On GitHub.com, owner/repo:path may reference another organization when the CodeRabbit App is installed there with access to the source repository. Every cross-organization source requires author and review-actor read access under the existing identity rules, even when named by trusted target configuration. Other providers require the same organization. Defaults include: (**/.cursorrules, .github/copilot-instructions.md, .github/instructions/**/*.instructions.md, **/CLAUDE.md, **/.claude/rules/**/*.md, **/GEMINI.md, .gemini/styleguide.md, **/.cursor/rules/*, **/.cursor/BUGBOT.md, **/.windsurfrules, **/.clinerules/*, **/.rules/*, **/AGENT.md, **/AGENTS.md, **/REVIEW.md, **/.greptile/rules.md). default: {} description: >- Use your coding guideline documents (see File Patterns) as review criteria. learnings: type: object properties: scope: enum: - local - global - auto type: string default: auto description: >- Learnings | Choose scope: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos). approval_delay: type: integer minimum: 0 maximum: 30 default: 0 description: >- Days admins have to approve or reject a learning before it is automatically applied. Must be an integer between 0 and 30. Set to 0 to apply learnings immediately without approval. default: {} issues: type: object properties: scope: enum: - local - global - auto type: string default: auto description: >- Issues | Choose scope for GitHub/GitLab issues: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos). default: {} jira: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Jira | Use Jira as a knowledge source. 'auto' disables the integration for public repositories. project_keys: type: array items: type: string default: [] description: >- Jira Project Keys | Restrict Jira context to these projects. excluded_project_keys: type: array items: type: string default: [] description: >- Jira Excluded Project Keys | Never use these Jira projects as CodeRabbit context, regardless of repository allowlists. Managed at the workspace level as a security policy; exclusions always take precedence over any allowlist. default: {} linear: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- Linear | Use Linear as a knowledge source. 'auto' disables the integration for public repositories. team_keys: type: array items: type: string default: [] description: >- Linear Team Keys | Restrict Linear context to these teams (e.g. 'ENG'). default: {} pull_requests: type: object properties: scope: enum: - local - global - auto type: string default: auto description: >- PRs | Choose scope: 'local' (repo), 'global' (org), or 'auto' (local for public repos, global for private repos). default: {} mcp: type: object properties: usage: enum: - auto - enabled - disabled type: string default: auto description: >- MCP | Use MCP servers as a knowledge source. 'auto' disables the integration for public repositories. disabled_servers: type: array items: type: string default: [] description: >- Disabled MCP Servers | Specify MCP server labels to disable (case-insensitive). These servers will be excluded from reviews and knowledge base queries. additionalProperties: false default: {} automatic_linking_mode: enum: - auto - enabled - disabled type: string default: disabled description: >- Automatic Linking Mode | For Auto, private repositories may automatically link to public or private repositories, while public repositories may automatically link only to public repositories. Enabled uses context from any eligible repository in the organization, whether public or private. Disabled creates no automatic repository links. Manual repository links configured below are unaffected. automatic_repository_linking: type: boolean default: false description: >- Automatic Repository Linking | Deprecated. This setting has no effect. Use `knowledge_base.automatic_linking_mode` instead. linked_repositories: type: array maxItems: 20 items: type: object properties: repository: type: string pattern: >- ^[a-zA-Z0-9](?:[\w .-]*[\w.-])?(?:\/(?:[a-zA-Z0-9](?:[\w .-]*[\w.-])?|\.[a-zA-Z0-9](?:[\w .-]*[\w.-])?))+$ description: >- Repository name in owner/repo format (e.g., GitHub: myorg/backend-api, Azure DevOps: My Project/backend-api, GitLab: group/subgroup/repo, Bitbucket: workspace/repo) instructions: type: string maxLength: 2000 default: '' description: >- Optionally provide description and guidance on what this repository contains for CodeRabbit to consider during reviews. Example: 'Contains REST API endpoints and database models.' required: - repository additionalProperties: false default: [] description: >- Linked Repositories | Repositories that CodeRabbit should consider when reviewing PRs in this repo. Use this to surface cross-repo dependencies and catch breaking changes across related codebases. default: {} code_generation: type: object properties: docstrings: type: object properties: language: enum: - de - de-DE - de-AT - de-CH - en - en-US - en-AU - en-GB - en-CA - en-NZ - en-ZA - es - es-AR - fr - fr-CA - fr-CH - fr-BE - nl - nl-BE - pt-AO - pt - pt-BR - pt-MZ - pt-PT - ar - ast-ES - ast - be-BY - be - br-FR - br - ca-ES - ca - ca-ES-valencia - ca-ES-balear - da-DK - da - de-DE-x-simple-language - el-GR - el - eo - fa - ga-IE - ga - gl-ES - gl - it - ja-JP - ja - km-KH - km - ko-KR - ko - pl-PL - pl - ro-RO - ro - ru-RU - ru - sk-SK - sk - sl-SI - sl - sv - ta-IN - ta - tl-PH - tl - tr - uk-UA - uk - zh-CN - zh - zh-TW - crh-UA - crh - cs-CZ - cs - nb - 'no' - nl-NL - de-DE-x-simple-language-DE - es-ES - it-IT - fa-IR - sv-SE - de-LU - fr-FR - bg-BG - bg - he-IL - he - hi-IN - hi - vi-VN - vi - th-TH - th - bn-BD - bn type: string default: en-US description: >- Language for generated docstrings (ISO language code). path_instructions: type: array items: type: object properties: path: type: string description: >- File path glob pattern. Example: `**/*.js`. instructions: type: string maxLength: 20000 description: >- Additional docstring-generation guidelines for matching paths. required: - path - instructions default: [] description: >- Path Instructions | Add path-specific guidelines for docstring generation. default: path_instructions: [] description: >- Docstring Generation | Settings for generating docstrings. unit_tests: type: object properties: path_instructions: type: array items: type: object properties: path: type: string description: >- File path glob pattern. Example: `**/*.js`. instructions: type: string maxLength: 20000 description: >- Additional unit-test-generation guidelines for matching paths. required: - path - instructions default: [] description: >- Path Instructions | Add path-specific guidelines for unit test generation. default: path_instructions: [] description: >- Unit Test Generation | Settings for generating unit tests. default: {} issue_enrichment: type: object properties: auto_enrich: type: object properties: enabled: type: boolean default: false description: >- Automatic Issue Enrichment | Analyze and enrich issues with additional context (related code, potential solutions, complexity assessment). default: {} description: Settings for automatic issue enrichment. planning: type: object properties: enabled: type: boolean default: true description: >- Issue Planning | Generate an implementation plan for issues (early preview). auto_planning: type: object properties: enabled: type: boolean default: true description: >- Automatic Planning | Trigger issue planning based on labels. labels: type: array items: type: string default: [] description: >- Labels that trigger automatic issue planning. Labels starting with '!' are negative matches. Examples: ['feature', 'enhancement'] plans issues with either label. ['!wip'] plans all issues except those labeled 'wip'. ['feature', '!wip'] plans issues labeled 'feature' but not 'wip'. default: {} default: {} description: Settings for issue planning. labeling: type: object properties: labeling_instructions: type: array items: type: object properties: label: type: string description: >- Label to suggest for the issue. Example: enhancement instructions: type: string maxLength: 3000 description: >- Instructions for the label. Example: New feature or request. required: - label - instructions default: [] description: >- Labeling Instructions | Define issue labels to suggest and when to suggest them. auto_apply_labels: type: boolean default: false description: >- Automatically apply suggested labels to the issue. When enabled without labeling instructions, labels are auto-suggested based on similar issues. default: {} description: Settings for issue labeling. default: {} additionalProperties: {} enabled: type: boolean data_opt_out: type: boolean settings_yaml: anyOf: - type: string maxLength: 131072 - type: string nullable: true enum: - null expected_settings_updated_at: anyOf: - type: string format: date-time - type: string nullable: true enum: - null required: - settings responses: '200': description: OK content: application/json: schema: type: object properties: updated: enum: - true required: - updated '400': description: '400' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - invalid_request type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '401': description: '401' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - unauthenticated type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '403': description: '403' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - forbidden type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '404': description: '404' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - not_found type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '409': description: '409' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - head_changed - conflict type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '412': description: '412' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - precondition_failed type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '413': description: '413' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - payload_too_large type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '429': description: '429' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - rate_limit_exceeded type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '500': description: '500' content: application/json: schema: type: object properties: error: type: object properties: code: enum: - internal_error type: string message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false '503': description: '503' content: application/json: schema: type: object properties: error: type: object properties: code: type: string enum: - unavailable message: type: string retry_after: type: integer minimum: 0 maximum: 9007199254740991 exclusiveMinimum: true required: - code - message additionalProperties: false required: - error additionalProperties: false components: securitySchemes: ApiKeyAuth: type: apiKey in: header name: x-coderabbitai-api-key description: >- API key for authentication. You can create an API key from the CodeRabbit dashboard. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.