PhoenixSwagger.Schema.example

You're seeing just the function example, go back to PhoenixSwagger.Schema module for more information.

example(model, example)

Adds an example of the schema.

Examples

iex> alias PhoenixSwagger.Schema
...> %Schema{type: :object, properties: %{phone_number: %Schema{type: :string}}}
...> |> Schema.example(%{phone_number: "555-123-456"})
%PhoenixSwagger.Schema{
  type: :object,
  properties: %{
    phone_number: %PhoenixSwagger.Schema{
      type: :string
    }
  },
  example: %{phone_number: "555-123-456"}
}