Schema annotation updates #601
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
Azquelt
force-pushed
the
schema-annotation-updates
branch
from
ce3ad94 to
d8b3f62
Compare
Azquelt
force-pushed
the
schema-annotation-updates
branch
from
d8b3f62 to
dc7eb28
Compare
Test new parameters on the Schema annotation which don't involve subschemas. - comment - const - dependentRequired - contentEncoding - contentMediaType
Azquelt
force-pushed
the
schema-annotation-updates
branch
from
dc7eb28 to
cd35c07
Compare
MikeEdgar
approved these changes
May 7, 2024
| @@ -40,10 +54,7 @@ | |||
| public @interface Schema { | |||
There was a problem hiding this comment.
What are your thoughts on having a String value() default "" property that could be used to set an arbitrary schema (that must be valid JSON/YAML)? That would give support for alternate dialects with the annotation.
I'm not sure myself, but I wanted to mention it as a possibility.
There was a problem hiding this comment.
That's certainly an interesting option which I hadn't considered. It becomes a bit more usable since Java 15 added text blocks too.
I'll raise a new issue to think about it.
There was a problem hiding this comment.
Opened #610 to continue the discussion after this is merged.
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 new fields to
@Schemaand@SchemaPropertyto support the new properties available in OpenAPI 3.1.Builds on the model changes from #598
New properties:
examplescommentconstValueifSchema/thenSchema/elseSchemadependentSchemascontains/maxContains/minContainsprefixItemspatternPropertiesdependentRequiredpropertyNamescontentEncoding/contentMediaType/contentSchemaAdditional changes:
examplein preference of usingexamplesexampleto preserve backward compatibilityTrueandFalsevalid everywhere thatClassis accepted to indicate a subschemaadditionalPropertiesadditionalPropertiesto@SchemaPropertyadditionalPropertiesin@SchemaProperty, then we may want to reconsider adding all the other new properties there also@SchemajavadocOther notes:
typeandnullableare unchanged to preserve backward compatibility