[Task]: [AI Workspace + Devportal] Documentation Improvements

[Thushani-Jayasekera]

Please select the area the issue is related to

AI Workspace

Please select the aspect the issue is related to

Aspect/Other (Anything else which does not match above categories)

Description

Please add any missing details or identify any areas in the documentation that could be improved as comments

Format

### Component (AI Workspace / Devportal / Gateway)

page url
description

[vinupa]

DevPortal

In the Quick Start Guide for DevPortal it states that "You should see the default API catalog page" upon logging in. But upon login, redirected back to the "default/views/default/" (instead of "default/views/default/apis").

[Thushani-Jayasekera]

AI Workspace

Add new documentation page - connecting an IDP with AI Workspace for auth

@Tharanidk

[CrowleyRajapakse]

Devportal

Subscribe to API docs: https://wso2.com/api-platform/docs/next/developer-portal/manage-subscriptions/subscribe-to-an-api/

need to be revamped to include token based related steps with proper screenshots

[CrowleyRajapakse]

Devportal

Adding web hooks and linking with Platform-API and adding a gateway in this mode needs to be properly documented, otherwise users can't try out and test for real.

Generic steps won't be enough to figure this out: https://wso2.com/api-platform/docs/next/developer-portal/admin-settings/webhook-integration/

[RakhithaRR]

AI Workspace

https://wso2.com/api-platform/docs/api-gateway/next/gateway-controller-management-api/llm-provider-template-management/

Issue 1

curl -X POST http://localhost:9090/api/management/v0.9/llm-provider-templates \
  -u {username}:{password} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -d @payload.json

The REST API version has been changed to v1 now. The docs should be updated to reflect this

Issue 2

You can only download YAMLs from the AI Workspace. But the documentation only provides a JSON based option when onboarding an LLM Provider Template. Might be better to say that you have either convert the YAML to a JSON or use YAML content by modifying the cURL.

@npamudika

[Thushani-Jayasekera]

AI Workspace

When using query parameter to send the api key, the key generation option is disappearing from the overview. Tried to invoke with a key generated with header option and it failed. looks like the policy only supports header.
Remove query param support from docs.

@npamudika

[Shamly-Shanawaz]

AI Workspace

https://wso2.com/api-platform/docs/next/ai-workspace/llm-providers/manage-provider/#models
Docs describe toggle switches to enable/disable individual models. The actual UI has no toggles, models are added/removed via a chip list. Doc does not reflect the actual UI.

https://wso2.com/api-platform/docs/next/ai-workspace/llm-providers/configure-provider/
Docs say "Select Service Providers from the menu," but the UI labels this section as LLM Providers

https://wso2.com/api-platform/docs/next/ai-workspace/llm-providers/manage-provider/#security
Docs describe two Key Location options, Header and Query. The UI only offers Header.

assigned to: @npamudika