docs: fix broken OpenAPI definition link in README - #2825
Open
vaibhav8a wants to merge 1 commit into
Open
Conversation
The OpenAPI definition link pointed at pkg/web/openapi/, which 404s since the package moved to pkg/http/openapi/.
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
1 participant
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.
The README links to the OpenAPI definition at
pkg/web/openapi/swagger-ui/api/v1/api.swagger.json, which 404s — the package was moved topkg/http/openapi/, so the file now lives atpkg/http/openapi/swagger-ui/api/v1/api.swagger.json.Verified against the current tree on
main:pkg/web/no longer exists, andpkg/http/openapi/swagger-ui/api/v1/api.swagger.jsondoes.One-line link fix. The other in-tree reference to the old path is in
docs/design-documents/20260713-ci-relevance-and-prepush-guard.md, which I left alone since design documents are a historical record of what was true when written.