Render OpenAPI 3.1 specs by upgrading Swagger UI to 5.x - #45
Merged
Merged
Conversation
Default Swagger UI ^3.0.0 doesn't understand openapi: 3.1.0, which broke rendering on the deployed docs site after v22.yaml was bumped to 3.1. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Summary
v22.yamlwith "The provided definition does not specify a valid version field" after the spec was bumped toopenapi: 3.1.0in c379d0f.Legion2/swagger-ui-action@v1defaults to bundling Swagger UI^3.0.0, which predates OpenAPI 3.1 support.@v1.3.0and passedversion: ^5.0.0so the deployed assets are Swagger UI 5.x — handles 3.1 (and renders 3.0.x identically).version: ^5.0.0to the v2.1 render step for consistency, even though 3.0.3 worked under the old default.Test plan
Releaseworkflow deploy to GitHub Pageshttps://scanii.github.io/openapi/v22/and confirm the spec renders (no version-field error)https://scanii.github.io/openapi/v21/and confirm v2.1 still renders🤖 Generated with Claude Code