[T] OpenAPI3ParameterBase
type OpenAPI3ParameterBase = Extensions & object;Type declaration
Section titled “Type declaration”| Name | Type | Description |
|---|---|---|
deprecated? | boolean | Specifies that a parameter is deprecated and SHOULD be transitioned out of usage. Default value is false. |
description? | string | A brief description of the parameter. This could contain examples of use. CommonMark syntax MAY be used for rich text representation. |
example? | any | A free-form property to include an example of an instance for this schema. To represent examples that cannot be naturally represented in JSON or YAML, a string value can be used to contain the example with escaping where necessary. |
examples? | Record<string, Refable<OpenAPI3Example>> | - |
explode? | boolean | When 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? | boolean | Determines 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. |
schema | OpenAPI3Schema | - |