View Source OpenApiSpex.MediaType (open_api_spex v3.18.0)

Defines the OpenApiSpex.MediaType.t type.

Link to this section Summary

Types

t()

Media Type Object

Link to this section Types

t()

@type t() :: %OpenApiSpex.MediaType{
  encoding: %{String => OpenApiSpex.Encoding.t()} | nil,
  example: any(),
  examples:
    %{
      required(String.t()) =>
        OpenApiSpex.Example.t() | OpenApiSpex.Reference.t()
    }
    | nil,
  extensions: %{required(String.t()) => any()} | nil,
  schema: OpenApiSpex.Schema.t() | OpenApiSpex.Reference.t() | nil
}

Media Type Object

Each Media Type Object provides schema and examples for the media type identified by its key.