Top Description Interfaces
module org.eclipse.microprofile.openapi

Package org.eclipse.microprofile.openapi.models.parameters

Annotations
@Version:1.0
@ProviderType
A set of model interfaces to describe operation parameters and operation's request body.

The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.

Example usage: 

.components(OASFactory.createObject(Components.class)
     .parameters(new HashMap<String, Parameter>())
         .addParameter("departureDate", OASFactory.createObject(Parameter.class)
             .required(true)
             .description("Customer departure date")
             .schema(OASFactory.createObject(Schema.class)))
         .addParameter("username", OASFactory.createObject(Parameter.class)
             .required(true)
             .description("The name that needs to be deleted")
             .schema(OASFactory.createObject(Schema.class)))

Interface Summary

Modifier and TypeInterface and Description
public interface
Parameter

Parameter

Describes a single operation parameter.

public interface
RequestBody

This interface represents the request body of an operation in which body parameters can be specified.