Skip to content

Add secret management related docs#328

Open
npamudika wants to merge 1 commit into
wso2:mainfrom
npamudika:secret-management-on-prem
Open

Add secret management related docs#328
npamudika wants to merge 1 commit into
wso2:mainfrom
npamudika:secret-management-on-prem

Conversation

@npamudika

Copy link
Copy Markdown

Purpose

Add docs for wso2/api-platform#2149

@CLAassistant

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Naduni Pamudika seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 3bed6669-16c8-4664-a105-5df665430f35

📥 Commits

Reviewing files that changed from the base of the PR and between 388895d and 0413802.

📒 Files selected for processing (2)
  • en/docs/next/ai-workspace/secrets-management.md
  • en/mkdocs.yml

📝 Walkthrough

Added a new AI Workspace documentation page for secrets management, covering how secrets are created, referenced, managed, and validated across the UI and runtime flow. The docs also include API usage for common secret lifecycle actions and guidance for configuring encryption. Updated the AI Workspace navigation to link to the new page.

Walkthrough

This pull request adds a new documentation page for Secrets Management under the AI Workspace section, covering how encrypted secrets are created, referenced via placeholders, resolved by the gateway, and rotated without redeployment. It documents the full secrets API (create, list, get, rotate, delete) with request/response examples and error cases, guidance for referencing secrets in artifact configurations, safe deletion using conflict details, and encryption key configuration via an environment variable. A corresponding navigation entry is added to the documentation site configuration.

Suggested reviewers: Krishanx92

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description only states the purpose and issue link; most required template sections are missing. Expand the PR description to follow the template and add the missing sections such as Goals, Approach, Checklist, Release note, Documentation, tests, and Security checks.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: adding secret management documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ 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.

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.

2 participants