Skip to content

Improve docs for the release #378

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
npamudika merged 5 commits into from
Jul 31, 2026
Merged

Improve docs for the release #378

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a7ac24d
Improve docs for the release
Jul 30, 2026
16a83f3
Fix review comments
Jul 30, 2026
fe155dc
Revert cloud/ai-workspace doc changes
Jul 30, 2026
199676b
Remove cloud/ai-workspace doc changes from PR
Jul 30, 2026
987cc8b
Fix formatting issue
Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions ...cs/api-gateway/next/gateway-controller-management-api/certificate-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Manage custom TLS certificates for HTTPS upstream verification

```shell

curl -X GET http://localhost:9090/api/management/v0.9/certificates \
curl -X GET http://localhost:9090/api/management/v1/certificates \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -86,7 +86,7 @@ Required roles: `admin`, `developer`

```shell

curl -X POST http://localhost:9090/api/management/v0.9/certificates \
curl -X POST http://localhost:9090/api/management/v1/certificates \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand Down Expand Up @@ -155,7 +155,7 @@ Required roles: `admin`, `developer`

```shell

curl -X DELETE http://localhost:9090/api/management/v0.9/certificates/{id} \
curl -X DELETE http://localhost:9090/api/management/v1/certificates/{id} \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -218,7 +218,7 @@ Status Code **200**

```shell

curl -X POST http://localhost:9090/api/management/v0.9/certificates/reload \
curl -X POST http://localhost:9090/api/management/v1/certificates/reload \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down
34 changes: 17 additions & 17 deletions ...s/api-gateway/next/gateway-controller-management-api/llm-provider-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ CRUD operations for LLM Provider configurations

```shell

curl -X POST http://localhost:9090/api/management/v0.9/llm-providers \
curl -X POST http://localhost:9090/api/management/v1/llm-providers \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand All @@ -40,7 +40,7 @@ Add a new LLM provider to the Gateway. A provider defines how to interact with a

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProvider",
"metadata": {
"name": "wso2-openai-provider"
Expand Down Expand Up @@ -106,7 +106,7 @@ Required roles: `admin`

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProvider",
"metadata": {
"name": "wso2-openai-provider"
Expand Down Expand Up @@ -177,7 +177,7 @@ Required roles: `admin`

```shell

curl -X GET http://localhost:9090/api/management/v0.9/llm-providers \
curl -X GET http://localhost:9090/api/management/v1/llm-providers \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -221,7 +221,7 @@ Required roles: `admin`, `developer`
"count": 2,
"providers": [
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProvider",
"metadata": {
"name": "wso2-openai-provider"
Expand Down Expand Up @@ -378,7 +378,7 @@ Status Code **200**

|Property|Value|
|---|---|
|apiVersion|gateway.api-platform.wso2.com/v1alpha1|
|apiVersion|gateway.api-platform.wso2.com/v1|
Comment thread
npamudika marked this conversation as resolved.
|kind|LlmProvider|
|hostRewrite|auto|
|hostRewrite|manual|
Expand All @@ -400,7 +400,7 @@ Status Code **200**

```shell

curl -X GET http://localhost:9090/api/management/v0.9/llm-providers/{id} \
curl -X GET http://localhost:9090/api/management/v1/llm-providers/{id} \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -429,7 +429,7 @@ Required roles: `admin`, `developer`

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProvider",
"metadata": {
"name": "wso2-openai-provider"
Expand Down Expand Up @@ -499,7 +499,7 @@ Required roles: `admin`, `developer`

```shell

curl -X PUT http://localhost:9090/api/management/v0.9/llm-providers/{id} \
curl -X PUT http://localhost:9090/api/management/v1/llm-providers/{id} \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand All @@ -513,7 +513,7 @@ Update an existing LLM provider in the Gateway.

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProvider",
"metadata": {
"name": "wso2-openai-provider"
Expand Down Expand Up @@ -580,7 +580,7 @@ Required roles: `admin`

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProvider",
"metadata": {
"name": "wso2-openai-provider"
Expand Down Expand Up @@ -651,7 +651,7 @@ Required roles: `admin`

```shell

curl -X DELETE http://localhost:9090/api/management/v0.9/llm-providers/{id} \
curl -X DELETE http://localhost:9090/api/management/v1/llm-providers/{id} \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -714,7 +714,7 @@ Status Code **200**

```shell

curl -X POST http://localhost:9090/api/management/v0.9/llm-providers/{id}/api-keys \
curl -X POST http://localhost:9090/api/management/v1/llm-providers/{id}/api-keys \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand Down Expand Up @@ -791,7 +791,7 @@ Required roles: `admin`, `consumer`

```shell

curl -X GET http://localhost:9090/api/management/v0.9/llm-providers/{id}/api-keys \
curl -X GET http://localhost:9090/api/management/v1/llm-providers/{id}/api-keys \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -856,7 +856,7 @@ Required roles: `admin`, `consumer`

```shell

curl -X POST http://localhost:9090/api/management/v0.9/llm-providers/{id}/api-keys/{apiKeyName}/regenerate \
curl -X POST http://localhost:9090/api/management/v1/llm-providers/{id}/api-keys/{apiKeyName}/regenerate \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand Down Expand Up @@ -931,7 +931,7 @@ Required roles: `admin`, `consumer`

```shell

curl -X PUT http://localhost:9090/api/management/v0.9/llm-providers/{id}/api-keys/{apiKeyName} \
curl -X PUT http://localhost:9090/api/management/v1/llm-providers/{id}/api-keys/{apiKeyName} \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand Down Expand Up @@ -1009,7 +1009,7 @@ Required roles: `admin`, `consumer`

```shell

curl -X DELETE http://localhost:9090/api/management/v0.9/llm-providers/{id}/api-keys/{apiKeyName} \
curl -X DELETE http://localhost:9090/api/management/v1/llm-providers/{id}/api-keys/{apiKeyName} \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down
38 changes: 26 additions & 12 deletions ...eway/next/gateway-controller-management-api/llm-provider-template-management.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ CRUD operations for LLM Provider Template configurations

```shell

curl -X POST http://localhost:9090/api/management/v0.9/llm-provider-templates \
curl -X POST http://localhost:9090/api/management/v1/llm-provider-templates \
Comment thread
npamudika marked this conversation as resolved.
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand All @@ -40,7 +40,7 @@ Add a new LLM provider template to the Gateway. A template defines token trackin

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
Comment thread
npamudika marked this conversation as resolved.
"kind": "LlmProviderTemplate",
"metadata": {
"name": "openai-template"
Expand Down Expand Up @@ -75,6 +75,20 @@ Add a new LLM provider template to the Gateway. A template defines token trackin
}
```

!!! note "Using a YAML downloaded from AI Workspace"
If you downloaded the template YAML from AI Workspace, you have two options to use it with this endpoint:

- **Convert to JSON:** Convert the YAML file to JSON before passing it as the request body with `-H 'Content-Type: application/json'`.
- **Send as YAML:** Pass the YAML file directly and change the content type header to `application/yaml`:

```shell
curl -X POST http://localhost:9090/api/management/v1/llm-provider-templates \
-u {username}:{password} \
-H 'Content-Type: application/yaml' \
-H 'Accept: application/json' \
--data-binary @template.yaml
```
Comment thread
npamudika marked this conversation as resolved.

### Authentication

<aside class="warning">
Expand All @@ -96,7 +110,7 @@ Required roles: `admin`

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProviderTemplate",
"metadata": {
"name": "openai-template"
Expand Down Expand Up @@ -155,7 +169,7 @@ Required roles: `admin`

```shell

curl -X GET http://localhost:9090/api/management/v0.9/llm-provider-templates \
curl -X GET http://localhost:9090/api/management/v1/llm-provider-templates \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -188,7 +202,7 @@ Required roles: `admin`
"count": 3,
"templates": [
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProviderTemplate",
"metadata": {
"name": "openai-template"
Expand Down Expand Up @@ -296,7 +310,7 @@ Status Code **200**

|Property|Value|
|---|---|
|apiVersion|gateway.api-platform.wso2.com/v1alpha1|
|apiVersion|gateway.api-platform.wso2.com/v1|
|kind|LlmProviderTemplate|
|location|payload|
|location|header|
Expand All @@ -315,7 +329,7 @@ Status Code **200**

```shell

curl -X GET http://localhost:9090/api/management/v0.9/llm-provider-templates/{id} \
curl -X GET http://localhost:9090/api/management/v1/llm-provider-templates/{id} \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down Expand Up @@ -344,7 +358,7 @@ Required roles: `admin`

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProviderTemplate",
"metadata": {
"name": "openai-template"
Expand Down Expand Up @@ -402,7 +416,7 @@ Required roles: `admin`

```shell

curl -X PUT http://localhost:9090/api/management/v0.9/llm-provider-templates/{id} \
curl -X PUT http://localhost:9090/api/management/v1/llm-provider-templates/{id} \
-u {username}:{password} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
Expand All @@ -416,7 +430,7 @@ Update an existing LLM provider template in the Gateway.

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProviderTemplate",
"metadata": {
"name": "openai-template"
Expand Down Expand Up @@ -473,7 +487,7 @@ Required roles: `admin`

```json
{
"apiVersion": "gateway.api-platform.wso2.com/v1alpha1",
"apiVersion": "gateway.api-platform.wso2.com/v1",
"kind": "LlmProviderTemplate",
"metadata": {
"name": "openai-template"
Expand Down Expand Up @@ -532,7 +546,7 @@ Required roles: `admin`

```shell

curl -X DELETE http://localhost:9090/api/management/v0.9/llm-provider-templates/{id} \
curl -X DELETE http://localhost:9090/api/management/v1/llm-provider-templates/{id} \
-u {username}:{password} \
-H 'Accept: application/json'

Expand Down
Loading