quarkus-smallrye-openapi ignores @Parameter (example "...") about quarkus

[phillip-kruger]

@nicolasduminil no, it's just easier to look at an issue if there is a reproducer :) @MikeEdgar I'll leave this to you.

[nicolasduminil]

@phillip-kruger : LOL ! It's even easier not to look at all ...

[quarkus-bot]

/cc @EricWittmann (openapi), @Ladicek (smallrye), @MikeEdgar (openapi), @jmartisk (smallrye), @phillip-kruger (openapi,smallrye), @radcortez (smallrye)

[phillip-kruger]

Can you share your openapi.json or yaml, that gets generated ?

[MikeEdgar]

In addition to what Phillip requested, I suspect you should be using an @RequestBody annotation rather than an @Parameter to represent a POST body.

@RequestBody(content = @Content(example = "your example"))

[nicolasduminil]

@phillip-kruger : I'm attaching here the openapi file.
openapi.zip

[nicolasduminil]

@MikeEdgar : using @RequestBody, as you suggested above, instead of @Parameter, didn't change anything to the mentioned behavior.

[phillip-kruger]

@nicolasduminil can you share a small reproducer ?

[nicolasduminil]

@phillip-kruger : I will as soon as I'll have the time. But since you need a reproducer, should I understand that you couldn't reproduce the issue by yourself ? I mean, do you confirm that you could test and using the @Parameter annotation, like in my example, or the @RequestBody one, like mentioned by @MikeEdgar, you succeeded to get the expected result ? And in this case, which one did you use, @Parameter or @RequestBody ?

[MikeEdgar]

I was able to get the example in the output using the @RequestBody annotation. That's the correct annotation for a POST body, although I believe the Swagger annotations use (or did use at one point) the @Parameter annotation. If you try again with @RequestBody maybe share here just the method you test and perhaps there is some other adjustment that you need.

[nicolasduminil]

@MikeEdgar : I neglected to mention that, in my case, I have separated the interface and implementation, as follows:

public interface CustomerResource
{
  @POST
  @Operation(description = "Create a new customer")
  @APIResponse(responseCode = "500", description = "An internal server error has occurred",    content = @Content(mediaType = APPLICATION_XML))
  @APIResponseSchema(value = Customer.class, responseDescription = "The new customer has been created", responseCode = "201")
  ...
  Response createCustomer (Customer customer, @Context UriInfo uriInfo) throws IOException;
}
...
@Path("customers")
@Produces(APPLICATION_JSON)
@Consumes(APPLICATION_JSON)
public class CustomerResourceImpl implements CustomerResource
{

  @Override
  public Response createCustomer(Customer customer, @Context UriInfo uriInfo) throws IOException
  {
    ...
  }
...
}

Does it change anything ? Is that supposed to work as well or is there any obligation to annotate the implementation and not the interface ?

[MikeEdgar]

I neglected to mention that, in my case, I have separated the interface and implementation
Does it change anything ? Is that supposed to work as well or is there any obligation to annotate the implementation and not the interface ?

It should support annotations like you have them. In your code snippet I don't see the @RequestBody, in which location are you using it?