[I] OpenAPIEncoding3_2
A single encoding definition applied to a single schema property.
https://spec.openapis.org/oas/v3.0.4.html#encoding-object
Extends
Section titled “Extends”Indexable
Section titled “Indexable”[key: `x-${string}`]: anyProperties
Section titled “Properties”| Property | Type | Description | Inherited from |
|---|---|---|---|
allowReserved? | boolean | Determines whether the parameter value SHOULD allow reserved characters, as defined by RFC3986 :/?#[]@!$&’()*+,;= to be included without percent-encoding. The default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded | OpenAPI3Encoding.allowReserved |
contentType? | string | the Content-Type for encoding a specific property. Default value depends on the property type: for string with format being binary – application/octet-stream; for other primitive types – text/plain; for object - application/json; for array – the default is defined based on the inner type. The value can be a specific media type (e.g. application/json), a wildcard media type (e.g. image/*), or a comma-separated list of the two types. | OpenAPI3Encoding.contentType |
encoding? | Record<string, OpenAPIEncoding3_2> | Applies nested Encoding Objects in the same manner as the OpenAPIMediaType3_2.encoding field See https://spec.openapis.org/oas/v3.2.0#common-fixed-fields-0 | - |
explode? | boolean | When this is true, property 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 properties this property has no effect. When style is form, the default value is true. For all other styles, the default value is false. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded. | OpenAPI3Encoding.explode |
headers? | Record<string, Refable<OpenAPI3Header>> | A map allowing additional information to be provided as headers, for example Content-Disposition. Content-Type is described separately and SHALL be ignored in this section. This property SHALL be ignored if the request body media type is not a multipart. | OpenAPI3Encoding.headers |
itemEncoding? | OpenAPIEncoding3_2 | Applies nested Encoding Objects in the same manner as the OpenAPIMediaType3_2.itemEncoding field See https://spec.openapis.org/oas/v3.2.0#common-fixed-fields-0 | - |
prefixEncoding? | OpenAPIEncoding3_2[] | Applies nested Encoding Objects in the same manner as the OpenAPIMediaType3_2.prefixEncoding field See https://spec.openapis.org/oas/v3.2.0#common-fixed-fields-0 | - |
style? | "pipeDelimited" | "spaceDelimited" | "form" | "deepObject" | Describes how a specific property value will be serialized depending on its type. See Parameter Object for details on the style property. The behavior follows the same values as query parameters, including default values. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded. | OpenAPI3Encoding.style |