Encoding

zio.http.api.openapi.OpenAPI$.Encoding
final case class Encoding(contentType: String, headers: Map[String, HeaderOrReference], style: String, explode: Boolean, allowReserved: Boolean)

A single encoding definition applied to a single schema property.

TODO: default values (https://spec.openapis.org/oas/v3.0.3#encoding-object)

Attributes

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.

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Members list

Concise view

Value members

Concrete methods

override def toJson: String

Attributes

Definition Classes
OpenAPIBase

Inherited methods

Attributes

Inherited from:
Product

Attributes

Inherited from:
Product