Encoding

zio.http.endpoint.openapi.OpenAPI.Encoding

See theEncoding companion object

final case class Encoding(contentType: String, headers: Map[String, ReferenceOr[Header]], style: String, explode: Boolean, allowReserved: Boolean)

A single encoding definition applied to a single schema property.

Value parameters

allowReserved: Determines whether the parameter value SHOULD allow reserved characters, as defined by [RFC3986] to be included without percent-encoding. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.
contentType: The Content-Type for encoding a specific property.
explode: 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.
headers: 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.
style: Describes how a specific property value will be serialized depending on its type. This property SHALL be ignored if the request body media type is not application/x-www-form-urlencoded.

Companion: object
Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

In this article

Generated with