Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "About this release"
description: "What's included in API Portal & MCP Hub 1.0.0: the API and MCP catalog, API workflows, MCP registry, applications, authentication, theming, and the admin UI."
canonical_url: https://wso2.com/api-platform/docs/cloud/api-portal/about-this-release/
md_url: https://wso2.com/api-platform/docs/cloud/api-portal/about-this-release.md
canonical_url: https://wso2.com/api-platform/docs/api-portal/about-this-release/
md_url: https://wso2.com/api-platform/docs/api-portal/about-this-release.md
tags:
- cloud
- api-portal
Expand All @@ -14,7 +14,7 @@ content_type: "release-notes"

# About this release

The API Portal & MCP Hub is a web application that serves a catalog of APIs, Model Context Protocol (MCP) servers, and API workflows. Publishers register artifacts in it, and developers browse them, subscribe to plans, generate credentials, and call the APIs. It runs as a standalone distribution alongside the Platform API control plane, keeps its own database, and reaches gateways through signed webhook events rather than a fixed control-plane binding.
The API Portal & MCP Hub is a web application that serves a catalog of APIs, Model Context Protocol (MCP) servers, and API workflows. Publishers register artifacts in it, and developers browse them, subscribe to plans, generate credentials, and call the APIs. It is a standalone product: it runs as its own distribution, keeps its own database, authenticates against your identity provider, and reaches gateways through signed webhook events rather than a fixed control-plane binding.

**API Portal & MCP Hub 1.0.0** is the first **API Portal & MCP Hub release**. Every capability listed below is available for the first time, so there is no predecessor to upgrade from.

Expand All @@ -25,8 +25,8 @@ For more information on the API Portal & MCP Hub, see the [overview](overview.md
Download the standalone distribution from the WSO2 API Platform release page:

```bash
curl -sLO https://github.com/wso2/api-platform/releases/download/api-portal%2Fv1.0.0-rc3/wso2apip-api-portal-1.0.0-rc3.zip && \
unzip wso2apip-api-portal-1.0.0-rc3.zip
curl -sLO https://github.com/wso2/api-platform/releases/download/api-portal%2Fv1.0.0/wso2apip-api-portal-1.0.0.zip && \
unzip wso2apip-api-portal-1.0.0.zip
```

To install and run it, follow the [Getting started](getting-started.md) guide.
Expand All @@ -42,7 +42,7 @@ To install and run it, follow the [Getting started](getting-started.md) guide.
- **Labels**: Tag and filter artifacts across views.
- **Per-artifact documentation**: Publish specifications, guides, and custom content next to each entry.

**[Learn more](discover-apis/api-search.md)**
**[Learn more](discover-apis/browse-apis.md)**

??? note "API workflows"

Expand All @@ -61,7 +61,7 @@ To install and run it, follow the [Getting started](getting-started.md) guide.
- **Machine-readable discovery**: Query published MCP servers and their connection details over HTTP.
- **Agent-oriented**: Intended for MCP clients and agent frameworks that resolve servers at runtime.

**[Learn more](mcp-servers/mcp-registry.md)**
**[Learn more](mcp-registry.md)**

??? note "AI agent discovery"

Expand All @@ -70,7 +70,7 @@ To install and run it, follow the [Getting started](getting-started.md) guide.
- **`llms.txt` entry points**: Machine-readable indexes of the APIs, MCP servers, and workflows a view serves.
- **Administrator-authored guidance**: Supply instructions that shape how large language models (LLMs) interpret the catalog.

**[Learn more](discover-apis/ai-agent-discovery.md)**
**[Learn more](ai-agent-discovery.md)**

??? note "Applications, subscriptions, and API keys"

Expand Down Expand Up @@ -102,7 +102,7 @@ To install and run it, follow the [Getting started](getting-started.md) guide.
- **Per-view layouts**: Upload page layouts that apply to a single view.
- **Per-API styling**: Apply custom styling to an individual API's landing page.

**[Learn more](theming.md)**
**[Learn more](admin-settings/theming.md)**

??? note "Design mode"

Expand All @@ -111,7 +111,7 @@ To install and run it, follow the [Getting started](getting-started.md) guide.
- **No infrastructure**: Preview APIs, MCP servers, applications, and theming without standing up the full stack.
- **Content and theme authoring**: Iterate on layouts and catalog content directly from disk.

**[Learn more](setting-up/design-mode.md)**
**[Learn more](admin-settings/design-mode.md)**

??? note "Webhook-based event integration"

Expand All @@ -137,17 +137,15 @@ To install and run it, follow the [Getting started](getting-started.md) guide.

None. This is the first release, so there is no earlier behavior to improve on.

## Compatible versions and requirements
## Compatible product versions

The distribution bundles the Platform API control plane, so the two are versioned and shipped together—no separate compatibility check is needed. Verify the following in your own environment:
The API Portal & MCP Hub shares a control plane with AI Workspace. The following product version was tested with this release:

| Component | Supported |
|---|---|
| Database | SQLite, PostgreSQL, or Microsoft SQL Server. See [Set up the database](setting-up/database.md) |
| Container runtime | Docker with the Compose plugin |
| Identity provider | Any OIDC-compliant provider issuing JWT access tokens. See [Connect an identity provider](setting-up/authentication/connect-an-identity-provider.md) |
| Product | Compatible version |
|---------|--------------------|
| WSO2 AI Workspace | 1.0.0 |

Full prerequisites are listed in the [Getting started](getting-started.md) guide.
The distribution bundles the Platform API control plane so the local-auth quickstart works out of the box, and the two are versioned and shipped together—no separate compatibility check is needed. A production deployment that authenticates against an identity provider doesn't need it: the portal's only outbound call to a Platform API is the local-auth login. Full prerequisites are listed in the [Getting started](getting-started.md) guide.

## Key changes

Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Customize an API's content"
description: "Replace an API's generated overview page with your own Markdown or Handlebars body, set its icon, and attach downloadable documents."
canonical_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/api-content/
md_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/api-content.md
canonical_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/api-content/
md_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/api-content.md
tags:
- cloud
- api-portal
Expand All @@ -14,9 +14,9 @@ content_type: "how-to"

# Customize an API's content

By default, an API's [overview page](../discover-apis/api-overview.md) is generated from its specification—Endpoints, Resources, Scopes, and the subscription plans panel. **API content** lets you replace that body with your own, per API, and attach the images and documents that go with it.
By default, an API's [overview page](../discover-apis/browse-apis.md#open-an-api) is generated from its specification—Endpoints, Resources, Scopes, and the subscription plans panel. **API content** lets you replace that body with your own, per API, and attach the images and documents that go with it.

This is narrower than [theming](../theming.md): a theme restyles every page in a view, while API content changes one API's overview body and leaves everything else alone.
This is narrower than [theming](theming.md): a theme restyles every page in a view, while API content changes one API's overview body and leaves everything else alone.

## What you can upload

Expand Down Expand Up @@ -67,7 +67,7 @@ Without it, the portal falls back to a generated avatar showing the first two le

## Attach documents

Files under `docs/` become the documents listed on the API's [documentation page](../discover-apis/api-documentations.md), and are served to AI agents as raw Markdown.
Files under `docs/` become the documents listed on the API's [documentation page](../discover-apis/browse-apis.md#read-the-specification-and-try-it), and are served to AI agents as raw Markdown.

The **first-level directory name becomes the section heading** in the documentation navigation. Files placed directly in `docs/` land in a section called **Other**:

Expand Down Expand Up @@ -95,11 +95,11 @@ Uploading is immediate and independent of **Save changes** on the other steps.
Files are merged rather than replaced wholesale: a file whose name matches one already stored overwrites it, and everything else is added. To remove a file, delete it through the [API Content](../rest-api/api-content.md) Management API.

!!! note "The wrapper directory is optional here"
A single top-level folder containing `web/` and `docs/` is fine, and so is `web/` and `docs/` sitting at the ZIP root—the portal accepts both. This differs from a [theme ZIP](../theming.md#package-the-theme), which requires the wrapper.
A single top-level folder containing `web/` and `docs/` is fine, and so is `web/` and `docs/` sitting at the ZIP root—the portal accepts both. This differs from a [theme ZIP](theming.md#package-the-theme), which requires the wrapper.

## Preview before uploading

In [design mode](../setting-up/design-mode.md), an API's content lives beside its manifest in the samples directory, so you can iterate on the body with a browser reload:
In [design mode](design-mode.md), an API's content lives beside its manifest in the samples directory, so you can iterate on the body with a browser reload:

```text
samples/apis/my-api-v1.0/
Expand All @@ -114,8 +114,8 @@ samples/apis/my-api-v1.0/

## Related

- [API Overview](../discover-apis/api-overview.md): the generated page your content replaces
- [API Documentation](../discover-apis/api-documentations.md): where `docs/` files surface
- [Theming](../theming.md): restyle every page in a view, rather than one API's body
- [API Overview](../discover-apis/browse-apis.md#open-an-api): the generated page your content replaces
- [API Documentation](../discover-apis/browse-apis.md#read-the-specification-and-try-it): where `docs/` files surface
- [Theming](theming.md): restyle every page in a view, rather than one API's body
- [Manage APIs](manage-apis.md): the wizard this is the last step of
- [API Content](../rest-api/api-content.md): upload, replace, and delete content through the Management API
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Apply a theme to a view"
description: "Upload a theme ZIP to a view in the API Portal & MCP Hub, download the current theme, or reset to the built-in default."
canonical_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/theming/
md_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/theming.md
canonical_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/apply-a-theme/
md_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/apply-a-theme.md
tags:
- cloud
- api-portal
Expand All @@ -16,7 +16,7 @@ content_type: "how-to"

The **Theming** tab in the API Portal's Settings page is where you upload a theme to a view, download what's currently applied, and roll back to the built-in default.

This page covers the panel. To build the theme in the first place—which files you can override, how the color tokens work, and how to package the ZIP—see [Theming](../theming.md).
This page covers the panel. To build the theme in the first place—which files you can override, how the color tokens work, and how to package the ZIP—see [Theming](theming.md).

Theming is configured **per view**: if your organization has more than one [view](manage-views.md), use the view switcher at the top of the panel to pick which one you're theming.

Expand All @@ -26,7 +26,7 @@ Theming is configured **per view**: if your organization has more than one [view
2. Pick the view you want to theme, if you have more than one.
3. Under **Upload Theme**, drag and drop (or browse to) a single ZIP archive, up to 10 MB.

The archive must hold **one wrapper directory** containing the theme's folders—`my-theme/styles/`, `my-theme/layout/`, `my-theme/partials/`, `my-theme/pages/`, `my-theme/images/`—not those folders at the archive root. See [Package the theme](../theming.md#package-the-theme); getting this wrong makes the layout silently not apply.
The archive must hold **one wrapper directory** containing the theme's folders—`my-theme/styles/`, `my-theme/layout/`, `my-theme/partials/`, `my-theme/pages/`, `my-theme/images/`—not those folders at the archive root. See [Package the theme](theming.md#package-the-theme); getting this wrong makes the layout silently not apply.

4. Click **Apply theme**.

Expand All @@ -49,6 +49,6 @@ Theming here controls the view-wide look and feel. To change one API's overview

## Related

- [Theming](../theming.md): build a theme, and the sample you can start from
- [Design Mode](../setting-up/design-mode.md): preview a theme before uploading it
- [Theming](theming.md): build a theme, and the sample you can start from
- [Design Mode](design-mode.md): preview a theme before uploading it
- [Manage Views](manage-views.md): themes are scoped per view
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Design Mode"
description: "Develop and preview API Portal layouts and themes offline, without a running database or identity provider."
canonical_url: https://wso2.com/api-platform/docs/cloud/api-portal/setting-up/design-mode/
md_url: https://wso2.com/api-platform/docs/cloud/api-portal/setting-up/design-mode.md
canonical_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/design-mode/
md_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/design-mode.md
tags:
- cloud
- api-portal
Expand All @@ -24,7 +24,7 @@ Design mode lets you develop and preview API page layouts and org-level themes w

Use design mode when you want to:

- Iterate on a [theme](../theming.md)—styles, layout, partials, or page templates—and see each change on reload
- Iterate on a [theme](theming.md)—styles, layout, partials, or page templates—and see each change on reload
- Work on a page design without standing up a database, an identity provider, or a gateway
- Demo the portal against a fixed set of sample APIs, MCP servers, and applications

Expand Down Expand Up @@ -81,9 +81,9 @@ enabled = true
path_to_layout = "./my-theme/"
```

To preview the example theme from [Theming](../theming.md#example-a-teal-and-coral-theme), use `./samples/layouts/green-theme/`.
To preview the example theme from [Theming](theming.md#example-a-teal-and-coral-theme), use `./samples/layouts/green-theme/`.

For what a theme contains, which files you can override, how the color tokens work, and how to package one for upload, see [Theming](../theming.md). Design mode and the production theme upload use the same directory structure, so a theme built here deploys without conversion.
For what a theme contains, which files you can override, how the color tokens work, and how to package one for upload, see [Theming](theming.md). Design mode and the production theme upload use the same directory structure, so a theme built here deploys without conversion.

## Sample APIs and MCP servers

Expand Down Expand Up @@ -228,6 +228,6 @@ The portal returns to production mode, requiring a database and (if configured)

## Related

- [Theming](../theming.md): what a theme contains, the color tokens, and how to package one
- [Theming](theming.md): what a theme contains, the color tokens, and how to package one
- [Apply a Theme](../admin-settings/theming.md): upload a finished theme to a view
- [Configurations](../references/configurations.md): the full `config.toml` reference
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Configure key managers in the API Portal & MCP Hub"
description: "Register the OAuth2 key managers applications can obtain access tokens from, using the API Portal Settings page."
canonical_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/key-manager-integration/
md_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/key-manager-integration.md
canonical_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/key-manager-integration/
md_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/key-manager-integration.md
tags:
- cloud
- api-portal
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: "Configure LLM instructions for the API Portal & MCP Hub"
description: "Set the portal name and description that head the llms.txt file, and turn AI discoverability on or off for the whole portal."
canonical_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/llm-instructions/
md_url: https://wso2.com/api-platform/docs/cloud/api-portal/admin-settings/llm-instructions.md
canonical_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/llm-instructions/
md_url: https://wso2.com/api-platform/docs/api-portal/admin-settings/llm-instructions.md
tags:
- cloud
- api-portal
Expand Down Expand Up @@ -69,11 +69,11 @@ The generated file lists each agent-visible artifact under its own section:

![Generated llms.txt showing an API Workflows section with workflow names, descriptions, and links](../../../assets/img/devportal/llms-txt.png)

Only your name and description are editable. Everything below them—the API Workflows, APIs, MCPs, GraphQL, WebSocket, and WebSub sections—is generated from the catalog and reflects each artifact's own agent visibility. See [AI Agent Discovery](../discover-apis/ai-agent-discovery.md) for how that index is built.
Only your name and description are editable. Everything below them—the API Workflows, APIs, MCPs, GraphQL, WebSocket, and WebSub sections—is generated from the catalog and reflects each artifact's own agent visibility. See [AI Agent Discovery](../ai-agent-discovery.md) for how that index is built.

## Related

- [AI Agent Discovery](../discover-apis/ai-agent-discovery.md): every agent-facing endpoint, and what `llms.txt` contains
- [Managing API Workflows](managing-api-workflows.md): per-workflow agent visibility
- [AI Agent Discovery](../ai-agent-discovery.md): every agent-facing endpoint, and what `llms.txt` contains
- [Managing API Workflows](manage-api-workflows.md): per-workflow agent visibility
- [Make an API AI-Ready](../../../cloud/develop-api-proxy/make-api-ai-ready.md): per-API agent visibility, and writing descriptions agents can use
- [Manage Views](manage-views.md): why these settings are per-view
Loading