Skip IO of fields added in OpenAPI 3.1 when reading or writing OpenAPI 3.0 documents #2117
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
Azquelt
force-pushed
the
drop-fields-30
branch
from
1b0a907 to
4ce300a
Compare
Azquelt
force-pushed
the
drop-fields-30
branch
from
4ce300a to
3d5dc6b
Compare
- Add a field to the model metadata indicating the minimum version of OpenAPI that includes that field - When reading or writing objects, ignore fields which require a newer version of OpenAPI than the one specified in the current document. When the metadata is updated to set the new field, this will prevent the inclusion of fields from OpenAPI 3.1 when writing OpenAPI 3.0 documents. Implementation notes: - Move IOContext.OpenApiVersion to its own file in the model project so we can use it from the OASModelProperty annotation. - Move generated SmallRyeOASModels.Properties interface to its own file in the model project so we can reference it from BaseModel. Rename to PropertyMetadata so that it doesn't clash with other uses of the word "properties". - Add a new method to BaseModel to get the PropertiesMetadata for the object. Add a PROPERTIES constant to each generated model class to implement this method.
Update the model metadata to set minVersion for all fields added in OpenAPI 3.1.
Test that new fields added for OpenAPI 3.1 are read and written correctly in 3.1 and 3.0 modes.
Azquelt
force-pushed
the
drop-fields-30
branch
from
3d5dc6b to
d721dcf
Compare
|
|
@MikeEdgar I wasn't planning any more functional changes. My previous push was to fix a couple of issues that sonarqube pointed out but I broke the imports >_> I now think it's good to merge. |
MikeEdgar
approved these changes
Dec 18, 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.
Add a new field to the model metadata to indicate which version of OpenAPI added the field.
I changed
SmallRyeOASModels.PropertiestoPropertyMetadataso that it doesn't conflict with other uses ofProperties, but I'd be happy to change the naming here if other people have better ideas.More detail in the commit messages.
Fixes #2105