Skip to content

Swagger YAML points to main instead of latest release #135

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
blkt opened this issue Jun 3, 2025 · 3 comments
Closed

Swagger YAML points to main instead of latest release #135

blkt opened this issue Jun 3, 2025 · 3 comments

Comments

@blkt
Copy link

blkt commented Jun 3, 2025

The code at this line points to the latest version of ToolHive API, which might differ from the latest release.

An alternative might be to ship a swagger.yaml file in ToolHive releases so that we can reference it unambiguously via a static URL like described in GitHub docs.

Note that the name of the artifact should be static and not containing the version number, otherwise it would be impossible to calculate.

@danbarr
Copy link
Collaborator

danbarr commented Jun 3, 2025

+1 thanks for noting this, totally agree the user docs should tie to the latest release and not main.

@danbarr
Copy link
Collaborator

danbarr commented Jun 5, 2025

I added a script to pull the CLI and API docs down from the latest release tarball, just need to wire it up as an action. My current idea is to trigger when a new release is cut in the app repo, and have it open a PR here to merge the updated docs, that auto-PR also becomes a good touchpoint/reminder to update other docs areas based on the release.

https://github.com/stacklok/codegate-docs/blob/website-refactor/scripts/get-imports.sh

@danbarr
Copy link
Collaborator

danbarr commented Jun 6, 2025

Closing; now tracked in stacklok/docs-website#1

@danbarr danbarr closed this as not planned Won't fix, can't repro, duplicate, stale Jun 6, 2025
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

No branches or pull requests

2 participants