Skip to content

[MASTER] Update Docs for Custom KM for OOB Mode#10708

Merged
dakshina99 merged 1 commit intowso2:masterfrom
dakshina99:custom-km-master
Feb 27, 2026
Merged

[MASTER] Update Docs for Custom KM for OOB Mode#10708
dakshina99 merged 1 commit intowso2:masterfrom
dakshina99:custom-km-master

Conversation

@dakshina99
Copy link
Copy Markdown
Contributor

@dakshina99 dakshina99 commented Feb 15, 2026

Description

Added documentation for custom key manager onboarding for Out-of-band provisioning.

Related Issue

Summary by CodeRabbit

  • Documentation
    • Added comprehensive guide for configuring Custom Key Manager with Out-of-Band provisioning mode using external OAuth 2.0 authorization servers, covering prerequisites, server setup, and Developer Portal workflow.
    • Updated documentation navigation menu to include new Key Manager configuration options.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Feb 15, 2026

Walkthrough

Three documentation files were added and updated to provide a comprehensive user guide for configuring a Custom Key Manager in Out-of-Band provisioning mode with external OAuth 2.0 authorization servers, along with corresponding navigation updates to the documentation site structure.

Changes

Cohort / File(s) Summary
Key Manager Configuration Guide
en/docs/administer/key-managers/configure-custom-km-out-of-band.md
New comprehensive user guide documenting end-to-end steps for configuring a Custom Key Manager in Out-of-Band provisioning mode: prerequisites, external authorization server setup, WSO2 API Manager Key Manager configuration via UI, Developer Portal usage, and token generation/validation workflow with OAuth 2.0 integration.
Documentation Navigation Updates
en/docs/administer/key-managers/overview.md, en/mkdocs.yml
Added navigation entries linking to the new Custom Key Manager Out-of-Band Provisioning configuration guide within the Key Managers documentation section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Poem

🐰 Hops of joy through docs so bright,
A Custom Key Manager guide, pure delight!
Out-of-Band provisioning paths unfold,
OAuth flows and secrets bold! 📚✨
With navigation smooth and clear,
Configuration's easy, nothing to fear! 🔑

🚥 Pre-merge checks | ✅ 3 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The PR description is minimal and incomplete compared to the repository template. It lacks critical sections such as Purpose/Goals, Approach, User stories, Release notes, Documentation links, Training, Certification, Marketing, Automation tests, Security checks, and other required fields. Complete the PR description using the required template. Add Purpose (with issue links), Goals, Approach, User stories, Release notes, Documentation references, and other applicable sections from the template to provide full context for reviewers.
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title is partially related to the changeset. It refers to a real part of the change (updating docs for custom key manager in OOB mode), but uses abbreviated terminology that could be clearer.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Merge Conflict Detection ✅ Passed ✅ No merge conflicts detected when merging into master

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

✨ Finishing Touches
  • 📝 Generate docstrings (stacked PR)
  • 📝 Generate docstrings (commit on current branch)
🧪 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

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.

Actionable comments posted: 3

🤖 Fix all issues with AI agents
In `@en/docs/administer/key-managers/configure-custom-km-out-of-band.md`:
- Line 79: Update the Introspection Endpoint table row to use consistent
capitalization and a clear descriptive phrase: change "introspection is **not
supported** for the OOB mode" to a capitalized, succinct description such as
"Not supported in Out‑of‑Band (OOB) mode" (or "Not supported in OOB mode") so it
matches other rows' style and reads as a field description rather than a caveat;
apply this change to the "Introspection Endpoint" row in the table.
- Line 127: The numbered list has a wrong step number for the final action:
change the line containing "Click **Add** to save the Key Manager
configuration." so its prefix number is 4 instead of 5; update the ordered list
item number to 4 (ensuring the surrounding steps remain 1–3 for the prior items
and the subsections remain under step 3) so the sequence reads 1, 2, 3, 4.

In `@en/docs/administer/key-managers/overview.md`:
- Around line 60-61: Update the markdown link text that currently reads "Custom
Key Manager (Out-of-Band Provisioning)" to match the project's link-title
pattern and the page title; change it to "Configure a Custom Key Manager for
Out-of-Band Provisioning" for the link pointing to
/administer/key-managers/configure-custom-km-out-of-band/ so it aligns with
other entries that follow "Configure X as a Key Manager".
🧹 Nitpick comments (1)
en/docs/administer/key-managers/configure-custom-km-out-of-band.md (1)

162-172: Steps 4 content is sparse — consider adding a sample token request and API invocation example.

Other Key Manager docs in this repo typically include sample curl commands for token generation and API invocation. Adding at least a generic example (with placeholder values) would make this guide more actionable for users, especially since OOB mode requires external token generation which may be unfamiliar.

Comment thread en/docs/administer/key-managers/configure-custom-km-out-of-band.md Outdated
Comment thread en/docs/administer/key-managers/configure-custom-km-out-of-band.md Outdated
Comment thread en/docs/administer/key-managers/overview.md Outdated
@CLAassistant
Copy link
Copy Markdown

CLAassistant commented Feb 23, 2026

CLA assistant check
All committers have signed the CLA.

@dakshina99 dakshina99 changed the base branch from master-backup to master February 23, 2026 09:31
@dakshina99 dakshina99 merged commit b006972 into wso2:master Feb 27, 2026
2 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.

3 participants