Skip to content

feat(portal): Upload API/package image #4856

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 4 commits into
base: main
Choose a base branch
from
+16 −0
Open

feat(portal): Upload API/package image #4856

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
50b1609
Add content for uploading image
cloudjumpercat Apr 14, 2026
5b4872b
fix that it's only edit flows that allow you to upload an image
cloudjumpercat Apr 14, 2026
572b6e5
Apply suggestions from code review
cloudjumpercat Apr 15, 2026
af649b6
fix steps so they're numbered
cloudjumpercat Apr 15, 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
3 changes: 3 additions & 0 deletions app/catalog/api-packaging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,9 @@ To package APIs with Dev Portal, you need:

Your operations should now be autogenerated based on how your OpenAPI spec maps to your Routes.

After you've created an API package, you can edit it to upload an image for the package that will display in Dev Portals it's published to.
Comment thread
cloudjumpercat marked this conversation as resolved.
Outdated
Copy link
Copy Markdown
Contributor

@Nathanael-Shermett Nathanael-Shermett Apr 15, 2026

Choose a reason for hiding this comment

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

Not a major issue, but any reason why this doesn't have a dedicated heading, whereas the reference in apis.md does?

Copy link
Copy Markdown
Contributor Author

@cloudjumpercat cloudjumpercat Apr 15, 2026

Choose a reason for hiding this comment

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

It was to match the current flow on the page. Since this one assumes you've already got APIs that you're packaging, users should be familiar with API catalog concepts that the other page broke into sections.

The image must be a PNG, JPG, or SVG image under 500 KB that’s no larger than 350 × 350 pixels.

### Publish packages to Dev Portal

1. In {{site.konnect_short_name}}, click **Catalog**.
Expand Down
8 changes: 8 additions & 0 deletions app/catalog/apis.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,6 +238,14 @@ Based on this data, you get the following generated URLs:
* Generated URL for `about` page: `/apis/routes-v3/docs/about`
* Generated URL for `info` page: `/apis/routes-v3/docs/about/info`

## API image

You can upload an image for your API.
The image is displayed as an icon for your API in Dev Portals it's published to.
Comment thread
cloudjumpercat marked this conversation as resolved.
Outdated
The image must be a PNG, JPG, or SVG image under 500 KB that’s no larger than 350 × 350 pixels.

To upload an API image, navigate to **Catalog > [APIs](https://cloud.konghq.com/apis)**. Edit an existing API and upload an image.
Comment thread
cloudjumpercat marked this conversation as resolved.
Outdated
Copy link
Copy Markdown
Contributor

@juliamrch juliamrch Apr 15, 2026

Choose a reason for hiding this comment

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

Suggested change
To upload an API image, navigate to **Catalog > [APIs](https://cloud.konghq.com/apis)**. Edit an existing API and upload an image.
To upload an API image:
1. Navigate to **Catalog > [APIs](https://cloud.konghq.com/apis)**.
2. Edit an existing API
3. Scroll until step **3. Set an image for your API**.
4. Upload an image..

What do you think of this format?

Copy link
Copy Markdown
Contributor Author

@cloudjumpercat cloudjumpercat Apr 15, 2026

Choose a reason for hiding this comment

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

Great feedback! I think the list works better than what I had.


## Allow developers to consume your API

You can link to a {{site.konnect_short_name}} [Gateway Service](/gateway/entities/service/) to allow developers to create applications and generate credentials or API keys. This is available to data planes running {{site.base_gateway}} 3.6 or later.
Expand Down
Loading