2024.1
Pre-releasere-released as 2024.2
not used.
(#92) (new) annotation mapping by OpenAPI extensions
it is now possible to use OpenAPI x-
tensions to add additional annotations to schema properties:
Here is a simple schema that has x-
tensions on the bar
property.
openapi: 3.1.0
# ...
components:
schemas:
Foo:
type: object
properties:
bar:
type: string
x-foo: single
x-bar:
- listA
- listB
we can now map the x-
tensions/values to annotations like this:
openapi-processor-mapping: v6
map:
extensions:
x-foo: single @ io.oap.FooA(value = "any")
x-bar:
- listA @ io.oap.FooB
- listB @ io.oap.FooC
.. which will generate the additional annotations on the property:
package generated.model;
import com.fasterxml.jackson.annotation.JsonProperty;
import generated.support.Generated;
import io.oap.FooA;
import io.oap.FooB;
import io.oap.FooC;
@Generated(value = "openapi-processor-core", version = "test")
public class Foo {
@FooA(value = "any")
@FooB
@FooC
@JsonProperty("bar")
private String bar;
public String getBar() {
return bar;
}
public void setBar(String bar) {
this.bar = bar;
}
}
(new) annotation mapping by parameter name
another small improvement to annotation mapping is that we can add annotations by parameter name:
openapi-processor-mapping: v6
map:
parameters:
- name: foo @ annotation.Foo
(may be breaking) (openapi-processor/openapi-processor-spring/issues/229) reactive bean validation
the position of the @Valid
annotation on reactive types has changed.
Until now the @Valid
was placed on the generic type of the reactive wrapper, like this:
@Mapping("/foo-flux")
void postFooFlux(@Parameter Flux<@Valid Bar> body);
but validation did not happen with Spring. Spring needs the @Valid
on the reactive wrapper to trigger the validation. Therefore @Valid
is now placed by default on the reactive wrapper:
@Mapping("/foo-flux")
void postFooFlux(@Parameter @Valid Flux<Bar> body);
It should only take a bit annotation clean up on the interface implementations to adapt your code to the new @Valid
position.
To postpone the update, set the bean-validation-valid-on-reactive
option to false
.
openapi-processor-mapping: v6
options:
bean-validation: jakarta
# default is true
bean-validation-valid-on-reactive: false
I would like to remove this option in the future. If you still need the old @Valid
position please create an issue to help me understand why the old @Valid
position is still useful.