Skip to content

feat(dev-portal): API composition and packaging#2664

Merged
jharmn merged 21 commits intomainfrom
feat/api-packaging
Jan 23, 2026
Merged

feat(dev-portal): API composition and packaging#2664
jharmn merged 21 commits intomainfrom
feat/api-packaging

Conversation

@cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented Aug 21, 2025

Description

Release branch for API composition.

Fixes #2459 #2355

Preview Links

https://deploy-preview-2664--kongdeveloper.netlify.app/catalog/api-packaging/

notes for writer reviewers: The instructions for creating an API package at the end aren't ideal, I am working on a how to in a separate PR, but the team moved the release up so I'm trying to get this one ready for release with the how to as a fast follow.

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).

@cloudjumpercat cloudjumpercat added do not merge Issues/ PRs whose changes should not be merged at this time release-docs Docs for release product:dev-portal labels Aug 21, 2025
@netlify
Copy link

netlify bot commented Aug 21, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 5737d80
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/697265a87ecd250008273cd3
😎 Deploy Preview https://deploy-preview-2664--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
Copy link
Contributor Author

@jharmn @gruceo In my latest commit, I've added more information about the ACE plugin config and limitations based on your feedback. In several spots we mention that using required and plugin misconfigurations can cause problems. What misconfigurations in particular? Can we tell users specifically what to avoid?

@gruceo
Copy link
Contributor

gruceo commented Sep 16, 2025

@cloudjumpercat setting the required match policy can block all traffic with a 404 if set. Any undefined endpoints will get blocked. If customers accidentally enable this in their control planes, that can cause a potential outage in production. We can add a warning like this one

Screenshot 2025-09-16 at 14 00 31

@andrewwylde
Copy link

andrewwylde commented Nov 7, 2025

If someone could update this ticket once we've merged, that'd be fantastic!

cloudjumpercat and others added 12 commits November 24, 2025 14:54
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>
Co-authored-by: Mike Swierenga <mike.swierenga@gmail.com>
…hey behave and display

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
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.
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>
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 20, 2026 22:04
@cloudjumpercat cloudjumpercat requested a review from a team as a code owner January 20, 2026 22:04
@jharmn
Copy link
Contributor

jharmn commented Jan 21, 2026

FYI preview link is wrong now that you moved to /catalog ;)

Signed-off-by: Diana <75819066+cloudjumpercat@users.noreply.github.com>
cloudjumpercat and others added 2 commits January 22, 2026 09:49
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
Signed-off-by: Diana <75819066+cloudjumpercat@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.

LGTM, I would just suggest linking to the full tutorial as well.

cloudjumpercat and others added 2 commits January 22, 2026 11:18
* 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>
Co-authored-by: lena-larionova <54370747+lena-larionova@users.noreply.github.com>
@jharmn jharmn merged commit 7c10731 into main Jan 23, 2026
16 checks passed
@jharmn jharmn deleted the feat/api-packaging branch January 23, 2026 18:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge Issues/ PRs whose changes should not be merged at this time product:dev-portal release-docs Docs for release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

API packaging - Feature flag docs

6 participants