LCORE-988: Regenerated configuration docs

[tisnik]

Description

LCORE-988: Regenerated configuration docs

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

Tools used to create PR

Identify any AI code assistants used in this PR (for transparency and review context)

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

Related Tickets & Documents

• Related Issue #LCORE-988

Summary by CodeRabbit

• Documentation
  • Added API key token authentication configuration documentation to the authentication schema.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

Documentation for configuration schema updated across three formats to introduce a new APIKeyTokenConfiguration class and add an api_key_config field to AuthenticationConfiguration, establishing the association between these configuration types.

Changes

Cohort / File(s)	Summary
Configuration documentation updates docs/config.html, docs/config.md, docs/config.puml	Added new APIKeyTokenConfiguration schema section with api_key field; extended AuthenticationConfiguration to include api_key_config field of type Optional[APIKeyTokenConfiguration]; updated class diagrams and documentation across HTML, Markdown, and PlantUML formats to reflect the new authentication configuration structure.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Documentation-only changes with consistent, repetitive pattern applied across three file formats
• Schema updates are straightforward additions without complex logic or interdependencies
• Changes are primarily additive (new configuration section and field) with minimal textual rewording

Possibly related PRs

• LCORE-287: fixed field descriptions #535: Adjusts authentication config references and api_key field handling in the configuration schema
• AAP-59476: API Key (Bearer) token auth module. #855: Adds the same APIKeyTokenConfiguration type and api_key_config field to AuthenticationConfiguration in auth module and model implementations
• LCORE-973: config documentation, 1st version #828: Introduces the base configuration documentation structures that this PR builds upon

Suggested labels

ok-to-test

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately summarizes the main change: regenerating configuration documentation across multiple doc files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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 (4)

docs/config.html (2)

179-196: Consider adding a description for the api_key field.

The api_key field in APIKeyTokenConfiguration lacks a description, which may leave users uncertain about its purpose, format, or usage. Since this is regenerated documentation, consider enhancing the source code docstring to provide context.

---

261-264: Missing type annotation for api_key_config field.

The table entry for api_key_config has empty Type and Description cells. Based on the PlantUML diagram, this should reference APIKeyTokenConfiguration. Consider updating the documentation generator to include type information for better clarity.

docs/config.md (2)

10-19: Consider adding a description for the api_key field.

The api_key field lacks a description. Adding documentation about its purpose (e.g., "API key for token-based authentication") would improve usability. Update the source docstring so it appears in regenerated docs.

---

56-56: Missing type information for api_key_config.

The table shows empty Type and Description columns. This should reference APIKeyTokenConfiguration based on the PlantUML diagram. Consider improving the documentation generation to include type references.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a1acee8 and 6557a6f.

⛔ Files ignored due to path filters (2)

• docs/config.png is excluded by !**/*.png
• docs/config.svg is excluded by !**/*.svg

📒 Files selected for processing (3)

• docs/config.html (2 hunks)
• docs/config.md (5 hunks)
• docs/config.puml (3 hunks)

🧰 Additional context used

🧠 Learnings (2)

📚 Learning: 2025-11-24T16:58:04.410Z

Learnt from: CR
Repo: lightspeed-core/lightspeed-stack PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:58:04.410Z
Learning: Applies to src/models/**/*.py : Pydantic configuration classes must extend `ConfigurationBase`; data models must extend `BaseModel`

Applied to files:

• docs/config.puml

📚 Learning: 2025-11-24T16:58:04.410Z

Learnt from: CR
Repo: lightspeed-core/lightspeed-stack PR: 0
File: CLAUDE.md:0-0
Timestamp: 2025-11-24T16:58:04.410Z
Learning: Applies to src/models/config.py : All configuration must use Pydantic models extending `ConfigurationBase` with `extra="forbid"` to reject unknown fields

Applied to files:

• docs/config.puml

🪛 LanguageTool

docs/config.md

[style] ~315-~315: Consider using “inaccessible” to avoid wordiness.
Context: ...figured in the llama-stack run.yaml are not accessible to lightspeed-core agents. Useful reso...

(NOT_ABLE_PREMIUM)

⏰ 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). (6)

• GitHub Check: build-pr
• GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
• GitHub Check: E2E: library mode / ci
• GitHub Check: E2E: library mode / azure
• GitHub Check: E2E: server mode / ci
• GitHub Check: E2E: server mode / azure

🔇 Additional comments (3)

docs/config.puml (3)

3-5: LGTM: New configuration class properly defined.

The APIKeyTokenConfiguration class is correctly added with its api_key field.

---

192-192: LGTM: Inheritance follows codebase conventions.

The APIKeyTokenConfiguration correctly extends ConfigurationBase, consistent with other configuration classes. Based on learnings, Pydantic configuration classes must extend ConfigurationBase.

---

13-25: Verify the dual field pattern for API key configuration.

The AuthenticationConfiguration includes both api_key_config: Optional[APIKeyTokenConfiguration] and api_key_configuration. This mirrors the existing pattern with jwk_config/jwk_configuration and rh_identity_config/rh_identity_configuration, suggesting these may be properties or aliases. Verify that both fields are intentional and properly implemented in the source code.

[tisnik]

/retest