Conversation
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
✅ Deploy Preview for kongdeveloper ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
There was a problem hiding this comment.
Pull request overview
Adds documentation to the API catalog and API packaging pages explaining that users can upload an image for APIs and API packages in Konnect, including supported formats and size constraints.
Changes:
- Documented how API images work in Dev Portal and where to upload them in Konnect.
- Documented API package image upload capability and the same image constraints.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| app/catalog/apis.md | Adds a new “API image” section describing upload behavior and constraints. |
| app/catalog/api-packaging.md | Adds a note about uploading an image for API packages and constraints. |
|
|
||
| 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. |
There was a problem hiding this comment.
Not a major issue, but any reason why this doesn't have a dedicated heading, whereas the reference in apis.md does?
There was a problem hiding this comment.
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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
juliamrch
left a comment
juliamrch
left a comment
There was a problem hiding this comment.
Nice update, I added a small suggestion to break down the action. Feel free to commit it if you think it's relevant to this page.
| 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, navigate to **Catalog > [APIs](https://cloud.konghq.com/apis)**. Edit an existing API and upload an image. |
There was a problem hiding this comment.
| 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?
There was a problem hiding this comment.
Great feedback! I think the list works better than what I had.
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Description
Fixes #4846
Preview Links
Checklist
descriptionentry in frontmatter.