Specifying the implementation schema

[irinaalbu89]

Hello.

I have a javax.ws.rs POST API which return a javax. ws. rs. core.Response. For different reasons I cannot change it to return a concrete model class, but I do want the openapi spec to be generated with the correct model class. How can I achieve this?
I tried with:

• @Schema(implementation = MyModelClass.class)
• @apiresponse(description = "Some desc",
  content = @content(mediaType = "application/json",
  schema = @Schema(implementation = MyModelClass.class)))
  but the api spec generated doesn't reflect this.

Are these annotations supported? If not, what else can I try?

Thank you!

[MikeEdgar]

@irinaalbu89 you're second example that uses @APIResponse should work. Can you provide the full method signature in case I can spot some other issue?

[irinaalbu89]

Hello @MikeEdgar . The method looks like this:

@POST
@Produces("application/json")
@Consumes("application/json")
@ApiResponse(description = "Some desc",
    content = @Content(mediaType = "application/json",
        schema = @Schema(implementation = MyModelClass.class)))
public Response testMethod(Info info, @Context HttpServletRequest request, @Context HttpServletResponse response) {
    return testService.testMethod(info, request, response);
}

[MikeEdgar]

Can you confirm the package of the @ApiResponse annotation? I question it because of the capitalization - Api versus API in the annotation we support.

If you are using io.swagger.v3.oas.annotations.responses.ApiResponse, please switch to org.eclipse.microprofile.openapi.annotations.responses.APIResponse.

[irinaalbu89]

Ooo, yes, I am using the swagger one!! Thank you very much for spotting this, this must be the issue!