Improvements to the schema for the key_value processor. #5051
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
This adds a none option to the whitespace enum while still supporting empty string. It includes default values to prevent fields from displaying that they are required. It also provides a solution for the schema generation which removes any property with a defaultValue from the list of required fields. Signed-off-by: David Venable <[email protected]>
dlvenable
requested review from
chenqi0805,
engechas,
graytaylor0,
dinujoh,
kkondaka,
KarstenSchnitter and
oeyh
as code owners
chenqi0805
reviewed
Oct 11, 2024
| protected boolean isRequired(final MemberScope<?, ?> member) { | ||
| final JsonProperty jsonPropertyAnnotation = member.getAnnotationConsideringFieldAndGetter(JsonProperty.class); | ||
| if(jsonPropertyAnnotation != null) { | ||
| if(jsonPropertyAnnotation.defaultValue() != null && !jsonPropertyAnnotation.defaultValue().isEmpty()) { |
There was a problem hiding this comment.
Do we have any cases where null value is allowed but defaultValue is not null?
There was a problem hiding this comment.
Technically you cannot provide null to the the annotation's defaultValue field. So this should never be reached. I added the != null as a defensive programming approach.
There was a problem hiding this comment.
For a more general point-of-view, anytime that a defaultValue is provided, regardless of the value, then the field is not required.
There was a problem hiding this comment.
Sorry my misread. I thought this condition means required.
chenqi0805
reviewed
Oct 11, 2024
| @@ -44,6 +45,8 @@ Function<String, String> getTransformFunction() { | |||
|
|
|||
| @JsonCreator | |||
| public static TransformOption fromTransformName(final String transformName) { | |||
| if(Objects.equals(transformName, "")) | |||
Signed-off-by: David Venable <[email protected]>
chenqi0805
approved these changes
Oct 11, 2024
graytaylor0
approved these changes
Oct 11, 2024
san81
pushed a commit
to san81/data-prepper
that referenced
this pull request
Oct 17, 2024
…roject#5051) Signed-off-by: David Venable <[email protected]>
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.
Description
This adds a none option to the whitespace enum while still supporting empty string. It includes default values to prevent fields from displaying that they are required. It also provides a solution for the schema generation which removes any property with a defaultValue from the list of required fields.
Issues Resolved
N/A
Check List
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.