tapir-openapi-model/sttp.tapir.openapi/Parameter

Parameter

final case class Parameter(name: String, in: ParameterIn, description: Option[String], required: Option[Boolean], deprecated: Option[Boolean], allowEmptyValue: Option[Boolean], style: Option[ParameterStyle], explode: Option[Boolean], allowReserved: Option[Boolean], schema: Option[ReferenceOr[Schema]], example: Option[ExampleValue], examples: ListMap[String, ReferenceOr[Example]], content: ListMap[String, MediaType], extensions: ListMap[String, ExtensionValue])
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Value members

Concrete methods

def addExample(key: String, updated: Example): Parameter
def addExtension(key: String, value: ExtensionValue): Parameter
def addMediaType(contentType: String, mediaType: MediaType): Parameter
def allowEmptyValue(updated: Boolean): Parameter
def allowReserved(updated: Boolean): Parameter
def deprecated(updated: Boolean): Parameter
def description(updated: String): Parameter
def example(updated: ExampleValue): Parameter
def examples(updated: ListMap[String, ReferenceOr[Example]]): Parameter
def explode(updated: Boolean): Parameter
def extensions(updated: ListMap[String, ExtensionValue]): Parameter
def in(updated: ParameterIn): Parameter
def name(updated: String): Parameter
def required(updated: Boolean): Parameter
def schema(updated: Schema): Parameter

Inherited methods

def productElementNames: Iterator[String]
Inherited from:
Product
def productIterator: Iterator[Any]
Inherited from:
Product