Skip to content

Improve docs for the release - #378

Merged
npamudika merged 5 commits into
wso2:mainfrom
npamudika:improve-docs-for-release
Jul 31, 2026
Merged

Improve docs for the release#378
npamudika merged 5 commits into
wso2:mainfrom
npamudika:improve-docs-for-release

Conversation

@npamudika

@npamudika npamudika commented Jul 30, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Fix inbound auth docs: remove query parameter support (policy only supports header-based API key auth)
  • Fix LLM Provider manage docs: replace toggle switch model enable/disable with chip list add/remove UI description
  • Fix LLM Provider manage docs: remove Key Location / Query option from Security tab (header only)
  • Fix LLM Provider configure docs: rename "Service Providers" → "LLM Providers" to match UI label
  • Fix LLM Provider Template Management API docs: update API version references and apiVersion value

Test plan

  • Verify inbound auth page no longer mentions query parameter location
  • Verify models section describes chip list UI
  • Verify Security tab fields table has no Key Location / Query row
  • Verify configure-provider steps say "LLM Providers" not "Service Providers"

Fixes related to wso2/api-platform#2933 (comment), wso2/api-platform#2933 (comment) and wso2/api-platform#2933 (comment)

@coderabbitai

coderabbitai Bot commented Jul 30, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The documentation updates move Gateway Controller Management API examples from v0.9/v1alpha1 to v1. AI Workspace guidance now documents header-only API-key authentication, updated provider navigation, chip-based model management, and redeployment after model changes.

Changes

Gateway Management API v1 documentation

Layer / File(s) Summary
Management API v1 endpoint examples
en/docs/api-gateway/next/gateway-controller-management-api/*.md
Curl examples now use /api/management/v1. Resource payloads and responses use gateway.api-platform.wso2.com/v1.
Management API v1 schema examples
en/docs/api-gateway/next/gateway-controller-management-api/schemas.md
Schema examples and enumerated apiVersion values now use gateway.api-platform.wso2.com/v1.

AI Workspace configuration documentation

Layer / File(s) Summary
Header-only API-key authentication
en/docs/next/ai-workspace/configure-inbound-auth.md, en/docs/next/ai-workspace/llm-providers/manage-provider.md, en/docs/next/ai-workspace/llm-proxies/manage-proxy.md
Authentication guidance now specifies request headers and removes query-parameter configuration.
Provider and model management workflows
en/docs/next/ai-workspace/llm-providers/configure-provider.md, en/docs/next/ai-workspace/llm-providers/manage-provider.md
Navigation, model chip management, model blocking, and redeployment guidance are updated.

Estimated code review effort: 2 (Simple) | ~15 minutes

Possibly related PRs

Suggested reviewers: thushani-jayasekera, krishanx92

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description summarizes the main changes and test plan but omits most required template sections, including purpose, goals, release note, documentation, and security checks. Complete the required template sections and state applicable values, including purpose, goals, release note, documentation links, testing, security checks, and certification impact.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title relates to the documentation changes but is broad and does not identify the API version and UI terminology updates.
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.

Comment thread en/docs/cloud/ai-workspace/configure-inbound-auth.md Outdated
Comment thread en/docs/cloud/ai-workspace/configure-inbound-auth.md
Comment thread en/docs/next/ai-workspace/llm-providers/manage-provider.md
Comment thread en/docs/next/ai-workspace/llm-providers/manage-provider.md Outdated
Comment thread en/docs/next/ai-workspace/llm-providers/manage-provider.md
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 30, 2026
@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 left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 5

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
en/docs/api-gateway/next/gateway-controller-management-api/websub-api-management.md (1)

635-635: 📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Capitalize ID in the heading.

Use sentence case and the standard acronym capitalization:

Proposed wording
-## Get WebSubAPI by id
+## Get a WebSub API by ID
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In
`@en/docs/api-gateway/next/gateway-controller-management-api/websub-api-management.md`
at line 635, Update the heading “Get WebSubAPI by id” to capitalize the acronym
as “ID” while preserving sentence case.

Source: Path instructions

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In
`@en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-management.md`:
- Line 381: Format both the apiVersion field name and its case-sensitive version
value as inline code in the rows at
en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-management.md:381,
llm-provider-template-management.md:313, llm-proxy-management.md:260,
mcp-proxy-management.md:320, rest-api-management.md:430, and
webbroker-api-management.md:390.

In
`@en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-template-management.md`:
- Around line 78-90: Update the “Using a YAML downloaded from AI Workspace”
admonition so the curl example is represented with a lint-recognized fenced code
block rather than an indented code block. Preserve the existing command and
admonition guidance, using the repository-approved MkDocs nested-fence pattern
or placing the fence outside the admonition.

In `@en/docs/cloud/ai-workspace/configure-inbound-auth.md`:
- Line 31: Remove the timeless “Currently” wording and state that header is the
only supported option in all affected descriptions:
en/docs/cloud/ai-workspace/configure-inbound-auth.md:31-31,
en/docs/next/ai-workspace/configure-inbound-auth.md:31-31,
en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md:148-148,
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md:148-148,
en/docs/cloud/ai-workspace/llm-providers/manage-provider.md:136-136, and
en/docs/next/ai-workspace/llm-providers/manage-provider.md:146-146. Use the
wording “The only supported option is `header`.” while preserving each table’s
existing field labels.

In `@en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md`:
- Around line 147-149: Insert a blank line between the final row of the
authentication table and numbered Save step 3 in both
en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md lines 147-149 and
en/docs/next/ai-workspace/llm-proxies/manage-proxy.md lines 147-150; no other
content changes are needed.

In `@en/docs/next/ai-workspace/llm-providers/manage-provider.md`:
- Line 147: Update the “API Key Value Prefix” table description in
manage-provider.md to use the requested grammatical wording: describe it as an
optional prefix prepended to the key value, such as `Bearer`, so clients send
`Bearer <key>`.

---

Outside diff comments:
In
`@en/docs/api-gateway/next/gateway-controller-management-api/websub-api-management.md`:
- Line 635: Update the heading “Get WebSubAPI by id” to capitalize the acronym
as “ID” while preserving sentence case.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 7857b47e-abaa-49e5-a7ad-0361b98feace

📥 Commits

Reviewing files that changed from the base of the PR and between 5663ce7 and 16a83f3.

📒 Files selected for processing (19)
  • en/docs/api-gateway/next/gateway-controller-management-api/certificate-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/llm-provider-template-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/llm-proxy-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/mcp-proxy-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/overview.md
  • en/docs/api-gateway/next/gateway-controller-management-api/rest-api-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/schemas.md
  • en/docs/api-gateway/next/gateway-controller-management-api/secrets-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/webbroker-api-management.md
  • en/docs/api-gateway/next/gateway-controller-management-api/websub-api-management.md
  • en/docs/cloud/ai-workspace/configure-inbound-auth.md
  • en/docs/cloud/ai-workspace/llm-providers/configure-provider.md
  • en/docs/cloud/ai-workspace/llm-providers/manage-provider.md
  • en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md
  • en/docs/next/ai-workspace/configure-inbound-auth.md
  • en/docs/next/ai-workspace/llm-providers/configure-provider.md
  • en/docs/next/ai-workspace/llm-providers/manage-provider.md
  • en/docs/next/ai-workspace/llm-proxies/manage-proxy.md

Comment thread en/docs/cloud/ai-workspace/configure-inbound-auth.md Outdated
Comment thread en/docs/cloud/ai-workspace/llm-proxies/manage-proxy.md Outdated
Comment thread en/docs/next/ai-workspace/llm-providers/manage-provider.md
Naduni Pamudika and others added 2 commits July 30, 2026 15:15
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
coderabbitai[bot]
coderabbitai Bot previously approved these changes Jul 30, 2026
Comment thread en/docs/next/ai-workspace/llm-proxies/manage-proxy.md

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@en/docs/next/ai-workspace/llm-proxies/manage-proxy.md`:
- Line 148: Update the “Sent in” table entry in the proxy documentation to
remove the temporal word “Currently,” leaving `header` described as the only
supported option while preserving the rest of the wording and formatting.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: 19bc9f29-28e9-45bc-be9b-935e7950922e

📥 Commits

Reviewing files that changed from the base of the PR and between 16a83f3 and 987cc8b.

📒 Files selected for processing (1)
  • en/docs/next/ai-workspace/llm-proxies/manage-proxy.md

Comment thread en/docs/next/ai-workspace/llm-proxies/manage-proxy.md
@npamudika
npamudika merged commit 1e633d5 into wso2:main Jul 31, 2026
1 of 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