ROB-2063 alert export api parameter is required

[RoiGlinik]

No description provided.

[coderabbitai]

Walkthrough

Documentation updated to mark the alert_name query parameter as required in the Alert Export API docs. No code or public API declarations were changed.

Changes

Cohort / File(s)	Summary
Docs: Alert Export API docs/configuration/exporting/alert-export-api.rst	Updated Query Parameters table: alert_name marked as Required: Yes (previously No).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Pre-merge checks (1 passed, 2 inconclusive)

❌ Failed checks (2 inconclusive)

Check name	Status	Explanation	Resolution
Title Check	❓ Inconclusive	The current title references the general change but does not specify which API parameter was affected or the concrete impact, making it only partially descriptive of the main change.	Please update the title to clearly state the change such as “Require alert_name parameter in Alert Export API (ROB-2063)” to improve specificity and readability.
Description Check	❓ Inconclusive	The pull request description is not provided or too minimal to assess its relevance and fails to describe the actual changes in the Alert Export API documentation.	Please include a concise description summarizing that the alert_name query parameter in the Alert Export API documentation has been changed from optional to required to give reviewers context.

✅ Passed checks (1 passed)

Check name	Status	Explanation
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

Tip

👮 Agentic pre-merge checks are now available in preview!

Pro plan users can now enable pre-merge checks in their settings to enforce checklists before merging PRs.

• Built-in checks – Quickly apply ready-made checks to enforce title conventions, require pull request descriptions that follow templates, validate linked issues for compliance, and more.
• Custom agentic checks – Define your own rules using CodeRabbit’s advanced agentic capabilities to enforce organization-specific policies and workflows. For example, you can instruct CodeRabbit’s agent to verify that API documentation is updated whenever API schema files are modified in a PR. Note: Upto 5 custom checks are currently allowed during the preview period. Pricing for this feature will be announced in a few weeks.

Example:

reviews:
  pre_merge_checks:
    custom_checks:
      - name: "Undocumented Breaking Changes"
        mode: "warning"
        instructions: |
          Pass/fail criteria: All breaking changes to public APIs, CLI flags, environment variables, configuration keys, database schemas, or HTTP/GraphQL endpoints must be documented in the "Breaking Change" section of the PR description and in CHANGELOG.md. Exclude purely internal or private changes (e.g., code not exported from package entry points or explicitly marked as internal).

Please share your feedback with us on this Discord post.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch ROB-2063-fix-alert-export-api-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/configuration/exporting/alert-export-api.rst (1)

37-41: Confirm backend enforcement and document error behavior for required alert_name.

Marking alert_name as required looks good, but please verify the API actually rejects requests missing this parameter and returns a clear 4xx with a deterministic error body. If so, consider adding a brief “Errors” note (status code + example JSON) so users know what to expect. Also confirm whether exact match/case sensitivity and multi-value (e.g., comma-separated) are supported, and reflect that here if applicable.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4a05432 and 7d72622.

📒 Files selected for processing (1)

• docs/configuration/exporting/alert-export-api.rst (1 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)

• GitHub Check: run_tests
• GitHub Check: run_tests
• GitHub Check: Deploy docs
• GitHub Check: Deploy docs