Skip to content

feat(dev-portal): API packaging how to#3580

Merged
cloudjumpercat merged 11 commits intofeat/api-packagingfrom
feat/packaing-how-to
Jan 22, 2026
Merged

feat(dev-portal): API packaging how to#3580
cloudjumpercat merged 11 commits intofeat/api-packagingfrom
feat/packaing-how-to

Conversation

@cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented Nov 27, 2025

Description

Fixes #2365

Left to do:

  • "Publish packages to Dev Portal" needs an updated path, APIs are in Catalog now
  • Add steps to add spec
  • Add prereq with the example-spec.yaml
  • Overall, need to decide if we're just going to do the straightforward "just create the package" or "create two packages to mimic the partner packaging use case" and tweak some of the steps/wording
  • Test whole flow (ACE doesn't seem to be available in our .com instance)

Preview Links

https://deploy-preview-3580--kongdeveloper.netlify.app/how-to/package-apis-with-dev-portal/

Checklist

  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter.
  • Add new pages to the product documentation index (if applicable).

@netlify
Copy link

netlify bot commented Nov 27, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 73c02a0
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/697242cffb4fd4000804a7be
😎 Deploy Preview https://deploy-preview-3580--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@cloudjumpercat cloudjumpercat changed the base branch from main to feat/api-packaging January 14, 2026 19:58
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
…making more specific

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat cloudjumpercat marked this pull request as ready for review January 21, 2026 17:09
@cloudjumpercat cloudjumpercat requested a review from a team as a code owner January 21, 2026 17:09
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

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

Tested, everything works. LGTM!

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
@cloudjumpercat cloudjumpercat merged commit 2d456cf into feat/api-packaging Jan 22, 2026
12 checks passed
@cloudjumpercat cloudjumpercat deleted the feat/packaing-how-to branch January 22, 2026 17:18
jharmn added a commit that referenced this pull request Jan 23, 2026
* Start outlining reference FF page

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Continue draft

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Finish FF draft docs

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix vale

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Mike Swierenga <mike.swierenga@gmail.com>

* GW service rate limit interaction, additional req role, clarify how they behave and display

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Revise API packaging guide for clarity and detail

Updated the API packaging guide to clarify the composition and management of API packages, including new use cases and improved descriptions of rate limits and access control.

* Minor copy edit

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply recommendation about spec to Gateway route mapping

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix the table formatting

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Fix tags, add ACE plugin config content, other feedback fixes

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply more feedback

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

* Make ace stuff includes, update steps, change file name and redirects

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Move packaging to catalog instead

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add backlinks, add to index and landing pages

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Appease vale

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* feat(dev-portal): API packaging how to (#3580)

* Start drafting how to

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Rename how to and revise some of the steps for UI changes as well as making more specific

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply more step changes, draft-ish the validation step

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Add example spec, basic validate, fix some steps

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Minor phrasing cleanup

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* fix broken links

* actually fix broken link

* Apply PM feedback, backlinks

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update GW min version

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

* Update app/catalog/api-packaging.md

Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>

---------

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
Co-authored-by: Mike Swierenga <mike.swierenga@gmail.com>
Co-authored-by: Jason Harmon <jason.harmon@konghq.com>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API packaging - how to

3 participants