module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.annotations.parameters

Annotations

@Version:1.2.1
@ProviderType

A set of annotations to describe and encapsulate operation parameters and operation's request body.

Example usage:

@Produces("application/json")
 public Response getReviewById(
         @Parameter(
             name = "id",
             description = "ID of the booking",
             required = true,
             in = ParameterIn.PATH,
             content = @Content(
                 examples = @ExampleObject(
                     name = "example",
                     value = "1")))
         @PathParam("id") int id)

Annotation Summary

Modifier and Type	Annotation and Description
public @interface	Parameter Describes a single operation parameter
public @interface	Parameters This object encapsulates input parameters
public @interface	RequestBody Describes a single request body.
public @interface	RequestBodySchema Provides a reference to a class that (after introspection) describes the schema for a single request body.