See: Description
Interface | Description |
---|---|
APIResponse |
This interface represents a single response from an API Operation, including design-time, static links to operations
based on the response.
|
APIResponses |
This interface represents the container for the expected responses of an operation.
|
The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.
Example usage:
.GET(OASFactory.createObject(Operation.class) .summary("Retrieve all bookings for current user") .operationId("getAllBookings") .responses(OASFactory.createObject(APIResponses.class) .addApiResponse("200", OASFactory.createObject(APIResponse.class) .description("Bookings retrieved") .content(OASFactory.createObject(Content.class) .addMediaType("applictaion/json", OASFactory.createObject(MediaType.class) .schema(OASFactory.createObject(Schema.class) .type(Schema.SchemaType.ARRAY) .ref("#/components.schemas.Booking")))))