Skip to content

LCORE-1348: Regenerated config doc#1392

Merged
tisnik merged 1 commit intolightspeed-core:mainfrom
tisnik:lcore-1348-regenerated-config-doc
Mar 24, 2026
Merged

LCORE-1348: Regenerated config doc#1392
tisnik merged 1 commit intolightspeed-core:mainfrom
tisnik:lcore-1348-regenerated-config-doc

Conversation

@tisnik
Copy link
Copy Markdown
Contributor

@tisnik tisnik commented Mar 24, 2026

Description

LCORE-1348: Regenerated config doc

Type of change

  • Refactor
  • New feature
  • Bug fix
  • CVE fix
  • Optimization
  • Documentation Update
  • Configuration Update
  • Bump-up service version
  • Bump-up dependent library
  • Bump-up library or tool used for development (does not change the final image)
  • CI configuration change
  • Konflux configuration change
  • Unit tests improvement
  • Integration tests improvement
  • End to end tests improvement
  • Benchmarks improvement

Tools used to create PR

  • Assisted-by: N/A
  • Generated by: N/A

Related Tickets & Documents

  • Related Issue #LCORE-1348

Summary by CodeRabbit

  • Documentation
    • Added MCP server management capabilities with register, list, and delete actions.
    • Introduced new configuration fields: allow_verbose_infer for customization, rhokp_url for OKP server URL configuration, and max_header_size for identity header size limits.
    • Updated configuration documentation with clearer field descriptions and improved examples for better clarity.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 24, 2026

Walkthrough

Configuration schema and documentation updated to support MCP server management actions, add verbose inference option, introduce OKP server URL configuration, refine chunk filter query documentation with Solr syntax guidance, and enforce identity header size limits.

Changes

Cohort / File(s) Summary
Schema and Configuration Updates
docs/config.json, docs/config.md, docs/config.html
Added three MCP management actions (register_mcp_server, list_mcp_servers, delete_mcp_server) to Action enum. Introduced allow_verbose_infer boolean (default false) in Customization schema. Extended OkpConfiguration with rhokp_url (nullable string) for base URL configuration and simplified chunk_filter_query description to reference Solr boolean syntax. Added max_header_size (integer, default 8192) to RHIdentityConfiguration for limiting base64-encoded identity header size before decoding.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title directly aligns with the changeset: documentation files were regenerated to reflect schema and configuration updates, matching the stated purpose.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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
Contributor

@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 (1)
docs/config.json (1)

632-635: Add a safety-oriented description for allow_verbose_infer.

This field is documented without any explanation, which makes operator intent unclear.

📝 Proposed schema doc improvement
           "allow_verbose_infer": {
             "default": false,
+            "description": "Allow /v1/infer to return extended metadata when requested. Keep disabled in production environments.",
             "title": "Allow Verbose Infer",
             "type": "boolean"
           }
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/config.json` around lines 632 - 635, The schema entry for
allow_verbose_infer lacks a description—add a "description" property to the
allow_verbose_infer object explaining that enabling verbose inference increases
logging detail and may expose sensitive/internal data (PII, prompts, model
internals), is intended for debugging only, and should remain false in
production; reference the existing keys "allow_verbose_infer", "default", and
"title" when editing so the added description clearly states the safety risks,
recommended usage (dev/debug only), and that operators should audit logs and
access controls if enabling it.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@docs/config.json`:
- Around line 632-635: The schema entry for allow_verbose_infer lacks a
description—add a "description" property to the allow_verbose_infer object
explaining that enabling verbose inference increases logging detail and may
expose sensitive/internal data (PII, prompts, model internals), is intended for
debugging only, and should remain false in production; reference the existing
keys "allow_verbose_infer", "default", and "title" when editing so the added
description clearly states the safety risks, recommended usage (dev/debug only),
and that operators should audit logs and access controls if enabling it.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: b19e5753-a30b-42f4-9cd5-c43580160e18

📥 Commits

Reviewing files that changed from the base of the PR and between b250fca and f7e8b88.

📒 Files selected for processing (3)
  • docs/config.html
  • docs/config.json
  • docs/config.md

@tisnik
Copy link
Copy Markdown
Contributor Author

tisnik commented Mar 24, 2026

/retest

@tisnik tisnik merged commit e7225b1 into lightspeed-core:main Mar 24, 2026
23 of 24 checks passed
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