diff --git a/app/catalog/api-packaging.md b/app/catalog/api-packaging.md index 07dc6d6017..5c51df3195 100644 --- a/app/catalog/api-packaging.md +++ b/app/catalog/api-packaging.md @@ -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 where the package is published. +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**. diff --git a/app/catalog/apis.md b/app/catalog/apis.md index 6dc928461c..a21c60b739 100644 --- a/app/catalog/apis.md +++ b/app/catalog/apis.md @@ -238,6 +238,19 @@ 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 any [Dev Portal](/dev-portal/) where the API is published. +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, do the following: +1. In the {{site.konnect_short_name}} sidebar, click **{{site.konnect_catalog}}**. +1. In the {{site.konnect_catalog}} sidebar, click **[APIs](https://cloud.konghq.com/apis)**. +1. Click the API you want to add the image to. +1. From the action menu, select "Edit". +1. Click **Upload image** and upload an image. + ## 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.