open_api_spex v3.4.0 OpenApiSpex.MediaType View Source
Defines the OpenApiSpex.MediaType.t type.
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %OpenApiSpex.MediaType{
encoding: %{optional(String) => OpenApiSpex.Encoding.t()} | nil,
example: any(),
examples:
%{
optional(String.t()) =>
OpenApiSpex.Example.t() | OpenApiSpex.Reference.t()
}
| nil,
schema: OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t() | nil
}
t() :: %OpenApiSpex.MediaType{
encoding: %{optional(String) => OpenApiSpex.Encoding.t()} | nil,
example: any(),
examples:
%{
optional(String.t()) =>
OpenApiSpex.Example.t() | OpenApiSpex.Reference.t()
}
| nil,
schema: OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t() | nil
}
Each Media Type Object provides schema and examples for the media type identified by its key.