Fixes NPE in springdoc-openapi-javadoc for nested parameters with a depth > 1 #1778
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
|
Thank you for your contribution to the project! |
bnasslahsen
added a commit
that referenced
this pull request
Aug 4, 2022
rudolfgrauberger
deleted the
null-pointer-exception-for-nested-query-param-with-depth-greater-1
branch
mpleine
pushed a commit
to mpleine/springdoc-openapi
that referenced
this pull request
May 17, 2025
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.
Describe the bug
You get the following NPE when you have an nested pojo as parameter with a depth > 1
To Reproduce
What version of spring-boot you are using?
1.6.9
What modules and versions of springdoc-openapi are you using?
springdoc-openapi-javadoc
What is the actual and the expected result using OpenAPI Description (yml or json)?
actual
{ "openapi": "3.0.1", "info": { "title": "OpenAPI definition", "version": "v0" }, "servers": [ { "url": "http://localhost", "description": "Generated server url" } ], "paths": { "/nested": { "get": { "tags": ["hello-controller"], "operationId": "nested", "parameters": [ { "name": "name", "in": "query", "description": "Returns the name of the outer class", "required": false, "schema": { "type": "string" } }, { "name": "innerClass.innerInnerClass.name", "in": "query", "description": "Returns the name of the inner inner class", "required": false, "schema": { "type": "boolean" } }, { "name": "innerClass.innerInnerClass.maxNumber", "in": "query", "description": "Returns the maxNumber of the inner inner class", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "innerClass.name", "in": "query", "description": "Returns the boolean name", "required": false, "schema": { "type": "boolean" } }, { "name": "innerClass.maxNumber", "in": "query", "description": "Returns the max number", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "*/*": { "schema": { "type": "string" } } } } } } }, "components": {} }Provide with a sample code (HelloController) or Test that reproduces the problem
All classes have a public getter method for each member. I have left this out in the example for easier reading
Expected behavior
If nested objects with a depth > 1 are possible as parameters, then the javadoc should also be able to query the documentation of these fields