Support OpenAPI 3.1 in addition to 3.0 #219
Merged
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
Closed
Kyle-Ye
reviewed
Aug 26, 2023
Kyle-Ye
approved these changes
Aug 26, 2023
… and properties can now be documented
glbrntt
approved these changes
Aug 29, 2023
Sources/swift-openapi-generator/Documentation.docc/Articles/Supported-OpenAPI-features.md
Show resolved
Hide resolved
Sources/swift-openapi-generator/Documentation.docc/Articles/Supported-OpenAPI-features.md
Show resolved
Hide resolved
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.
Motivation
Fixes #39. We need to start accepting 3.1 documents in addition to 3.0.
It also has useful features, like being able to add descriptions to references.
Modifications
Migrated the codebase to use the
OpenAPIKitinstead of theOpenAPIKit30module, and updated the parser to handle both 3.0 and 3.1, and convert 3.0 to 3.1 documents in memory transparently.Result
OpenAPI 3.1 documents are now accepted, instead of rejected. Any 3.1 specific features can be addressed separately, this is the MVP support.
Test Plan
Updated the file-based reference test to use version 3.1.0, and the parser tests that 3.0.x documents are loaded and converted successfully. So no need to duplicate our reference tests or anything.