io.vertx.openapi.contract

Interface Parameter

All Superinterfaces:

OpenAPIObject

public interface Parameter
extends OpenAPIObject

This interface represents the most important attributes of an OpenAPI Parameter.
Parameter V3.1
Parameter V3.0

Method Summary

Modifier and Type	Method and Description
Location	getIn()
String	getName()
JsonSchema	getSchema()
SchemaType	getSchemaType()
Style	getStyle()
boolean	isExplode()
boolean	isRequired()

Methods inherited from interface io.vertx.openapi.contract.OpenAPIObject

getOpenAPIModel

Method Detail

getName

String getName()

Returns:

name of this parameter

getIn

Location getIn()

Returns:

location of this parameter

isRequired

boolean isRequired()

Returns:

true if the parameter is required, otherwise false;

getStyle

Style getStyle()

Returns:

style of this parameter

isExplode

boolean isExplode()

Returns:

true if the parameter should become exploded, otherwise false;

getSchema

JsonSchema getSchema()

Returns:

the JsonSchema of the parameter

getSchemaType

SchemaType getSchemaType()

Returns:

the SchemaType of the parameter