-
-
Notifications
You must be signed in to change notification settings - Fork 505
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support returning null in ParameterCustomizer
#2822
Labels
enhancement
New feature or request
Comments
i am not sure exactly of your use case, but i have added an enhancement to support similar use case. |
ndwlocatieservices
added a commit
to ndwnu/nls-accessibility-map
that referenced
this issue
Jan 14, 2025
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [nu.ndw.nls.locationdataissuesapi:client-feign](https://dev.azure.com/ndwnu/NLS/_git/nls-location-data-issues) ([source](https://dev.azure.com/ndwnu/NLS/_git/nls-location-data-issues)) | compile | patch | `1.0.17` -> `1.0.18` | | [org.springdoc:springdoc-openapi-starter-webmvc-ui](https://springdoc.org/) ([source](https://github.com/springdoc/springdoc-openapi)) | compile | minor | `2.7.0` -> `2.8.0` | --- ### Release Notes <details> <summary>springdoc/springdoc-openapi (org.springdoc:springdoc-openapi-starter-webmvc-ui)</summary> ### [`v2.8.0`](https://github.com/springdoc/springdoc-openapi/blob/HEAD/CHANGELOG.md#280---2025-01-03) [Compare Source](springdoc/springdoc-openapi@v2.7.0...v2.8.0) ##### Added - [#​2790](springdoc/springdoc-openapi#2790) - Moving to OpenAPI 3.1 as the default implementation for springdoc-openapi - [#​2817](springdoc/springdoc-openapi#2817) - Obey annotations when flattening ParameterObject fields - [#​2826](springdoc/springdoc-openapi#2826) - Make it possible to mark parameters with [@​RequestParam](https://github.com/RequestParam) annotation to be sent in form instead of query. - [#​2822](springdoc/springdoc-openapi#2822) - Support returning null in ParameterCustomizer - [#​2830](springdoc/springdoc-openapi#2830) - Add support for deprecated fields. - [#​2780](springdoc/springdoc-openapi#2780) - Add Security Schema by AutoConfigure ##### Changed - Upgrade spring-boot to 3.4.1 - Upgrade spring-cloud-function to 4.2.0 - Upgrade swagger-core to 2.2.27 ##### Fixed - [#​2804](springdoc/springdoc-openapi#2804) - Stable release 2.7.0 depends on Spring Cloud Milestone 4.2.0-M1 - [#​2828](springdoc/springdoc-openapi#2828) - Required a bean of type 'org.springframework.data.rest.webmvc.mapping.Associations' that could not be found. - [#​2823](springdoc/springdoc-openapi#2823) - Capturing pattern in identical paths only renders the path element of one method - [#​2817](springdoc/springdoc-openapi#2817) - Automatically add required if a field is [@​notNull](https://github.com/notNull) or [@​NotBlank](https://github.com/NotBlank). - [#​2814](springdoc/springdoc-openapi#2814) - An unresolvable circular reference with management.endpoint.gateway.enabled=true. - [#​2798](springdoc/springdoc-openapi#2798) - Object schema generated for Unit Kotlin type. - [#​2797](springdoc/springdoc-openapi#2797) - Removing operationId via customizer does not w...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Is your feature request related to a problem? Please describe.
My use case is that I'd like to hide certain operation parameters based on an annotation and an environment specific condition. I've successfully done this with
OperationCustomizer
andPropertyCustomizer
without any issues but unfortunately in case ofParameterCustomizer
this results in aNullPointerException
.Describe the solution you'd like
ParameterCustomizer
to support returning null values and omit the parameter from the OpenAPI JSON if customizer returns nullDescribe alternatives you've considered
I considered setting some property with a specific value in
Parameter
and later filter it out in theOperationCustomizer
. This works but a bit ugly.Additional context
Here is my customizer...
...causing this exception:
The text was updated successfully, but these errors were encountered: