docs: 3.5 Swagger UI should reference 3.5 OpenAPI spec -- 3.5 specific #13824
Conversation
This file contains 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
- this PR is specific to the `release-3.5` branch - will modify this upon backport to `release-3.4` Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
agilgur5
added
area/docs
2 tasks
Joibel
approved these changes
Oct 31, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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 "Future Work" part 2 of #13818
Motivation
As we have versioned docs now (#11390), the Swagger UI should reference the OpenAPI spec of its release, not
mainModifications
In
swagger.md, change the raw GH URL frommaintorelease-3.5mainbefore this change. (the spec was always pointing tomainboth before and after, for clarity)Verification
mkdocs build && open site/swagger/index.htmlrelease-3.5spec.Screenshot:
Notes to Reviewers
This PR is specific to the
release-3.5branchrelease-3.4