Migrate to Openapi 3.1.2 #533
Merged
Conversation
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
3.0 -> 3.1 migration guide, "Use examples not example", https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
With the upgrade to OAI 3.1, the underlying schema has been synced to JSONSchema Draft 2020-12, meaning we now have access to patternProperties. We can use this to better specify the semantic requirements of QualifierSetConstraint keys.
OpenAPI 3.1.2 allows same-level `$ref`s and arbitrary adjacent keywords, meaning we don't need to use single-entry `oneOf`s to combine a `$ref` and a `description`
This was referenced Jan 8, 2026
colleenXu
approved these changes
Jan 9, 2026
Closed
edeutsch
approved these changes
Jan 9, 2026
vdancik
approved these changes
Jan 9, 2026
gprice1129
approved these changes
Jan 9, 2026
MarkDWilliams
approved these changes
Jan 9, 2026
This was referenced Jan 9, 2026
Closed
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.
Note
This PR depends on an upstream PR #532
Addresses #534
OpenAPI 3.1 is an important step forward, and vastly reduces ambiguities as compared to 3.0, given that there is now a true dependency on JSONSchema, rather than a custom JSONSchema-like set.
This PR brings TRAPI up to OpenAPI 3.1.2, making requisite migration changes, and utilizing some new abilities for QualifierSetConstraint specificity.