Skip to content

feat(dev-portal): Extended Try it out parameters #3865

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

Open
cloudjumpercat wants to merge 2 commits into
base: main
Choose a base branch
from
+25 −1
Open

feat(dev-portal): Extended Try it out parameters #3865

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8626d19
Draft try it out extension update
cloudjumpercat Jan 8, 2026
30a2da5
Apply feedback
cloudjumpercat Jan 9, 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
26 changes: 25 additions & 1 deletion app/catalog/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -410,7 +410,10 @@ Once published, the API appears in the selected Dev Portal. If [user authenticat

When you upload a spec for your API to Dev Portal, you can use the **Try it!** feature to allow developers to try your API right from Dev Portal. **Try it!** enables developers to add their authentication credentials, path parameters, and request body from the spec renderer in Dev Portal and send the request with their configuration.

The **Try it!** feature is enabled by default for published APIs. You can disable it by sending a PATCH request to the [`/v3/portals/{portalId}/customization` endpoint](/api/konnect/portal-management/v3/#/operations/update-portal-customization). You must also enable the CORS plugin for this feature to work. Use the table below to determine the appropriate CORS configuration based on the Routes associated with your APIs:
The **Try it!** feature is enabled by default for published APIs. You can disable it by sending a PATCH request to the [`/v3/portals/{portalId}/customization` endpoint](/api/konnect/portal-management/v3/#/operations/update-portal-customization).


You may need to enable the CORS plugin for this feature to work. Use the table below to determine the appropriate CORS configuration based on the Routes associated with your APIs:

{% feature_table %}
item_title: Use case
Expand Down Expand Up @@ -440,6 +443,27 @@ features:
cors: "[Enable Try it in Dev Portal for requests with any header](/plugins/cors/examples/try-it-headers/)"
{% endfeature_table %}

When using OAuth2 flows, some IdPs may require including additional parameters for token requests. You can include the `x-kong-client-credentials-config` property in `oauth2` type `securitySchemes` to allow users to input specific values for predefined parameters.

For example, this configuration allows spec renderer users to specify a custom audience value that is specific to their request:

```yaml
components:
securitySchemes:
oauth2:
type: oauth2
x-kong-client-credentials-config:
extraTokenRequestParameters:
- name: audience
label: Audience
description: The audience of the authorization server to scope tokens to
omitIfEmpty: true
required: true
flows:
clientCredentials:
tokenUrl: 'https://example.com/oauth/token'
```

### Filtering published APIs in Dev Portal

You can filter and categorize published APIs on your Dev Portals with custom attributes. By assigning attributes to an API, this allows users to filter APIs in the Dev Portal sidebar. For an API, you can define one or more custom attributes, and each attribute can have one or more values. For example, if you had a Billing API, you could label it with `"visibility": ["Internal"]` and `"platform": ["Web", "Mobile"]`.
Expand Down
Loading