[ROB-1828] added api-docs

[Avi-Robusta]

No description provided.

[coderabbitai]

Walkthrough

Two documentation files were updated. The first adds details for a new API endpoint that returns counts of specified Kubernetes resources within a namespace, including request/response formats and usage examples. The second expands configuration documentation for the Robusta UI sink, describing how to customize namespace resource monitoring and rescan intervals.

Changes

File(s)	Change Summary
docs/configuration/exporting/exporting-data.rst	Added documentation for a new API endpoint to query active counts of specific Kubernetes resources.
docs/configuration/sinks/RobustaUI.rst	Added section on configuring monitored resources and rescan intervals for the Robusta UI sink.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Possibly related PRs

• [ROB-1605] Custom Namespaced resource monitoring #1869: Adds code for counting and monitoring custom namespaced Kubernetes resources, matching the documented API and configuration features in this PR.

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs-for-apis

---

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

🪧 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai generate unit tests to generate unit tests for this 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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/configuration/sinks/RobustaUI.rst (1)

69-71: Fix minor typo (“the the”).
There is a duplicated article: “via the the Robusta Backend”. Drop one “the” to avoid distracting readers.

docs/configuration/exporting/exporting-data.rst (1)

662-664: Remove duplicated word (“the the”).
Same typo appears here: “relies on resource types configured in the the Robusta Backend”.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 057519a and 92d87a9.

📒 Files selected for processing (2)

• docs/configuration/exporting/exporting-data.rst (1 hunks)
• docs/configuration/sinks/RobustaUI.rst (1 hunks)

🧰 Additional context used

🪛 Gitleaks (8.27.2)

docs/configuration/exporting/exporting-data.rst

708-709: Discovered a potential authorization token provided in a curl command header, which could compromise the curl accessed resource.

(curl-auth-header)

⏰ 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

🔇 Additional comments (3)

docs/configuration/sinks/RobustaUI.rst (1)

85-99: Verify resource kind values – Kubernetes kinds are singular.
In Kubernetes API objects, kind is conventionally singular (Service, Deployment, CronJob, Ingress, etc.).
Using plural forms may lead to confusion when users copy-paste this YAML into their values file.

Example correction:

- kind: "Services"
+ kind: "Service"

Please double-check whether the backend truly expects plural strings or if this is a documentation slip.

docs/configuration/exporting/exporting-data.rst (2)

716-721: Confirm plural kind identifiers in request example.
The example payload uses Deployments, Ingresses, Services, ReplicationControllers, etc.
Kubernetes kind is normally singular. If the API really expects plural values, call that out explicitly; otherwise, switch to singular to save users from 400-series errors.

---

708-710: No real token exposed – OK
Authorization: Bearer API-KEY-HERE is clearly a placeholder, so the Gitleaks alert is a false positive. No action needed.