changes to pull in new API docs and display them#3174
Merged
matthewhelmke merged 3 commits intochainguard-dev:mainfrom Apr 6, 2026
Merged
changes to pull in new API docs and display them#3174matthewhelmke merged 3 commits intochainguard-dev:mainfrom
matthewhelmke merged 3 commits intochainguard-dev:mainfrom
Conversation
✅ Deploy Preview for ornate-narwhal-088216 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Collaborator
Author
|
The version of the API JSON files I just committed work beautifully on my local machine. I have permission from the PM to push what we have, even if it's broken, and fix tomorrow if that is what has to happen. So, let's try it!! |
s-stumbo
approved these changes
Apr 6, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes/finishes https://github.com/chainguard-dev/internal/issues/5709
WE ARE WAITING FOR TEST JSON FILES, so don't merge yet as this still wants testing.
Once the new API docs are pushed to a Google Cloud storage location, we need to pull them and display them separately and render them properly.
This changes
action.yamlfrom pulling one fileapi.jsonto pulling all files that fit the glob patternapi*.json, as all of them will. That gives us a little flexibility as we change v2 from alpha to beta to prod later.It adds two new pages and edits the existing one. The existing page will display a "unified API" which I have not yet seen. Another is dedicated to the current v1 and the final to v2.
The rendering works via a shortcode that takes a URL as an argument and then uses Scalar, so we should be all set with this (I want to test, though, of course).