Streamline annotating a method's @Response when using JAX-RS Response object

Originally posted in SmallRye here: https://github.com/smallrye/smallrye-open-api/issues/76

Content copy/pasted from source:

---

OpenApi has an ApiResponse annotation which, via its nested Content, can provide the information about the JAX-RS Response entity class.

While this annotation covers well for a case where Response dynamically sets different entity types per the current response media type, it is too complex for a typical case of Response returning a known single entity type only, with @Produces already typing a response media type.

One proposal is to have something like this:

@Produces("application/json")
@ApiResponseType(MyType.class)
@GET
public Response get() { return Response.ok(new MyType()).build(); }   

but other options should also be considered

[MikeEdgar]

Assuming everyone agrees this should be a new annotation and not a modification to ApiResponse and @RequestBody, how about the following (to keep the naming in alignment with existing objects). Whether or not there are additional attributes besides value (status code?), also needs to be determined.

@ApiResponseSchema(value = MyResponse.class)
@RequestBodySchema(value = MyRequest.class)

[arthurdm]

I like those names @MikeEdgar, +1

My suggestion is to keep these new annotations very simple, with just the single field (Pojo ref). For anything else, such as setting multiple responses based on status code, the user would then utilize @APIResponses & @APIResponse.