Skip to content

MAIT-139: Add Box connector configuration and documentation#39

Open
acikabubo wants to merge 1 commit intomainfrom
MAIT-139-box-connector
Open

MAIT-139: Add Box connector configuration and documentation#39
acikabubo wants to merge 1 commit intomainfrom
MAIT-139-box-connector

Conversation

@acikabubo
Copy link
Copy Markdown
Contributor

Summary

  • Adds Box cloud storage connector block to config.yaml.example (folder mode, file_ids, user-level access)
  • Adds BOX1_* env vars to .env.rag.example
  • Adds ### Box Connector section to README.md with config and dotenv examples

Adds Box cloud storage connector config examples, env vars, and README
section covering CCG authentication, folder/file_ids modes, and user-level access.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 20, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Documentation

    • Added Box connector configuration documentation with setup instructions for OAuth credentials, folder/file selection, and scheduling options.
  • Chores

    • Added example environment variable and configuration file templates for Box connector setup.

Walkthrough

Added Box connector support documentation and example configuration files. Three files were updated to include Box OAuth/client credential environment variables, configuration examples with folder/file selection options, and usage documentation for the Box cloud storage connector.

Changes

Cohort / File(s) Summary
Box Connector Configuration & Documentation
.env.rag.example, README.md, config.yaml.example
Added environment variable placeholders for Box credentials (BOX1_CLIENT_ID, BOX1_CLIENT_SECRET, BOX1_ENTERPRISE_ID, BOX1_USER_ID, BOX1_SCHEDULES). Documented Box connector configuration supporting Client Credential Grant, folder-based ingestion with optional recursion, explicit file selection, user-level CCG access, and scheduling. Provided example configuration templates.
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely summarizes the main change: adding Box connector configuration and documentation to the project.
Description check ✅ Passed The description is directly related to the changeset, providing specific details about what was added: Box configuration block, environment variables, and README documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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

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

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (2)
.env.rag.example (1)

87-87: Use an empty default for BOX1_USER_ID to avoid accidental whitespace values.

If someone uncomments this line as-is, they may keep a space-only value. Prefer #BOX1_USER_ID= and keep the explanation on a separate comment line.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.env.rag.example at line 87, The example env line uses a spaced value which
can lead to accidental whitespace when uncommented; change the sample to use an
empty default like "BOX1_USER_ID=" (no trailing spaces) and move the explanatory
text to its own comment line above or below so that the uncommented variable
will be blank rather than a space-only value; update the example entry
referencing BOX1_USER_ID accordingly.
README.md (1)

304-304: Prefer BOX1_USER_ID= (no padded spaces) in dotenv example.

This avoids users unintentionally keeping whitespace as the value when they copy/paste and uncomment.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 304, The dotenv example currently shows a padded value for
BOX1_USER_ID which can cause accidental whitespace when users copy/paste; update
the example to use a clean assignment "BOX1_USER_ID=" (no trailing spaces) so
the variable is empty by default and safe to uncomment, ensuring other similar
env examples follow the same pattern.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.env.rag.example:
- Line 87: The example env line uses a spaced value which can lead to accidental
whitespace when uncommented; change the sample to use an empty default like
"BOX1_USER_ID=" (no trailing spaces) and move the explanatory text to its own
comment line above or below so that the uncommented variable will be blank
rather than a space-only value; update the example entry referencing
BOX1_USER_ID accordingly.

In `@README.md`:
- Line 304: The dotenv example currently shows a padded value for BOX1_USER_ID
which can cause accidental whitespace when users copy/paste; update the example
to use a clean assignment "BOX1_USER_ID=" (no trailing spaces) so the variable
is empty by default and safe to uncomment, ensuring other similar env examples
follow the same pattern.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9cbe0b64-de73-435e-980c-7ba45d42ed9e

📥 Commits

Reviewing files that changed from the base of the PR and between 40f8bc4 and 03d48ff.

📒 Files selected for processing (3)
  • .env.rag.example
  • README.md
  • config.yaml.example

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant