Skip to content

[T] OpenAPI3ParameterBase

type OpenAPI3ParameterBase = Extensions & object;

Type declaration

NameTypeDescription
deprecated?booleanSpecifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false.
description?stringA brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
explode?booleanWhen this is true, parameter values of type array or object generate separate parameters for each value of the array or key-value pair of the map. For other types of parameters this property has no effect. When style is form, the default value is true. For all other styles, the default value is false.
required?booleanDetermines whether this parameter is mandatory. If the parameter location is β€œpath”, this property is REQUIRED and its value MUST be true. Otherwise, the property MAY be included and its default value is false.
schemaOpenAPI3Schema-