Guard against null parameter fields in OpenAPI operation parsing#1453
Open
mcruzdev wants to merge 5 commits into
Open
Guard against null parameter fields in OpenAPI operation parsing#1453mcruzdev wants to merge 5 commits into
mcruzdev wants to merge 5 commits into
Conversation
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Note
Copilot was unable to run its full agentic suite in this review.
This PR hardens OpenAPI/Swagger operation parameter handling by normalizing default values and adding null-safety around parameter fields during parameter extraction.
Changes:
- Default
UnifiedOpenAPI.Parameter.requiredtofalsewhen unspecified. - Add null checks for
parameter.in()andschemawhen filtering/processing Swagger v2 body parameters.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| impl/openapi/src/main/java/io/serverlessworkflow/impl/executors/openapi/UnifiedOpenAPI.java | Normalizes Parameter.required to a non-null default (false). |
| impl/openapi/src/main/java/io/serverlessworkflow/impl/executors/openapi/OperationDefinition.java | Adds null-safety when checking parameter location (in) and resolving schema refs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
fjtirado
reviewed
Jun 15, 2026
| if (operation.hasParameters()) { | ||
| for (UnifiedOpenAPI.Parameter parameter : operation.parameters()) { | ||
| if (parameter.in().equals("body")) { | ||
| if (parameter.in() != null && "body".equals(parameter.in())) { |
Collaborator
There was a problem hiding this comment.
Suggested change
| if (parameter.in() != null && "body".equals(parameter.in())) { | |
| if ("body".equals(parameter.in())) { |
fjtirado
reviewed
Jun 15, 2026
| && operation.parameters() != null) { | ||
| operation.parameters().stream() | ||
| .filter(p -> p.in().equals("body")) | ||
| .filter(p -> p.in() != null && "body".equals(p.in())) |
Collaborator
There was a problem hiding this comment.
Suggested change
| .filter(p -> p.in() != null && "body".equals(p.in())) | |
| .filter(p -> "body".equals(p.in())) |
fjtirado
reviewed
Jun 15, 2026
| } | ||
|
|
||
| public record Parameter(String name, String in, Boolean required, Schema schema) {} | ||
| public record Parameter(String name, String in, Boolean required, Schema schema) { |
Collaborator
There was a problem hiding this comment.
Im wondering if we can make required field a boolean rather than a Boolean and skip that check
fjtirado
reviewed
Jun 15, 2026
Comment on lines
+168
to
+172
| public record Parameter(String name, String in, Boolean required, Schema schema) { | ||
| public Parameter { | ||
| required = required != null ? required : Boolean.FALSE; | ||
| } | ||
| } |
Collaborator
There was a problem hiding this comment.
Yes, I tested it and it is working
Suggested change
| public record Parameter(String name, String in, Boolean required, Schema schema) { | |
| public Parameter { | |
| required = required != null ? required : Boolean.FALSE; | |
| } | |
| } | |
| public record Parameter(String name, String in, boolean required, Schema schema) { | |
| } |
Signed-off-by: Matheus Cruz <matheuscruz.dev@gmail.com>
| } | ||
|
|
||
| public record Parameter(String name, String in, Boolean required, Schema schema) {} | ||
| public record Parameter(String name, String in, boolean required, Schema schema) {} |
Comment on lines
79
to
83
| UnifiedOpenAPI.Schema schema = p.schema(); | ||
| if (schema.hasRef()) { | ||
| if (schema != null && schema.hasRef()) { | ||
| String ref = schema.ref(); | ||
| schema = openAPI.resolveSchema(ref); | ||
| } |
Comment on lines
+73
to
75
| if (openAPI.swaggerVersion() == UnifiedOpenAPI.SwaggerVersion.SWAGGER_V2 | ||
| && operation.parameters() != null) { | ||
| operation.parameters().stream() |
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
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.
Guard against null parameter fields in OpenAPI operation parsing
Add null checks before dereferencing Parameter.in() and Schema in
OperationDefinition, so parameters without an explicit "in" value or
schema no longer trigger NullPointerExceptions during parsing.