The APIResponseSchema annotation corresponds to an individual schema in the OpenAPI Response model object which describes a single response from an API Operation. This annotation provides a short-hand way to specify a simple response that would otherwise be specified using @APIResponse and that typically could not be determined by scanning the resource method alone.

The following annotation usages are equivalent to the OpenAPI annotation scanner runtime.

@APIResponse(content = { @Content(schema = @Schema(implementation = MyResponseObject.class)) })

@APIResponseSchema(MyResponseObject.class)

When this annotation is applied to a method the response is added to the responses defined in the corresponding OpenAPI operation with a default response code and description that correspond to the method's HTTP method annotation and return type. Any media types that apply to the resource method from either a method-level or class-level @Produces annotation will result in those media types applying to the OpenAPI response model.

If not specified, default responseCode and responseDescription values shall be determined according to the responseCode and responseDescription documentation.

@GET
@Path("{id}")
@APIResponseSchema(value = MyResponseObject.class, responseDescription = "Success", responseCode = "200")
public Response getById(@PathParam("{id}") long id) {
    MyResponseObject entity = service.load(id);
    return Response.status(200).entity(entity).build();
}