Merge pull request #31498 from drmaniac/resteasy-openapi-31486

gsmet · web-flow · commit 213985133d21 · 2023-03-02T09:31:26.000+01:00
Added a note to get correct OpenAPI documentation
diff --git a/docs/src/main/asciidoc/resteasy-reactive.adoc b/docs/src/main/asciidoc/resteasy-reactive.adoc
@@ -383,13 +383,14 @@ public class Endpoint {
     }
 
     @POST
-    public String allParams(Parameters parameters) {
+    public String allParams(@BeanParam Parameters parameters) { <1>
         return parameters.type + "/" + parameters.variant + "/" + parameters.age 
             + "/" + parameters.level + "/" + parameters.secretHandshake
             + "/" + parameters.smell;
     }
 }
 ----
+<1>  `BeanParam` is required to comply with the JAX-RS specification so that libraries like OpenAPI can introspect the parameters.
 
 === Declaring URI parameters
 

Original file line number	Diff line number	Diff line change
`@@ -383,13 +383,14 @@ public class Endpoint {`
`383`	`383`	`}`
`384`	`384`
`385`	`385`	`@POST`
`386`		`- public String allParams(Parameters parameters) {`
	`386`	`+ public String allParams(@BeanParam Parameters parameters) { <1>`
`387`	`387`	`return parameters.type + "/" + parameters.variant + "/" + parameters.age`
`388`	`388`	`+ "/" + parameters.level + "/" + parameters.secretHandshake`
`389`	`389`	`+ "/" + parameters.smell;`
`390`	`390`	`}`
`391`	`391`	`}`
`392`	`392`	`----`
	`393`	+<1> `BeanParam` is required to comply with the JAX-RS specification so that libraries like OpenAPI can introspect the parameters.
`393`	`394`
`394`	`395`	`=== Declaring URI parameters`
`395`	`396`