PhoenixSwagger.Schema.required

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

required(model, name)

Makes one or more properties required in an object schema.

Examples

iex> alias PhoenixSwagger.Schema
...> %Schema{type: :object, properties: %{phone_number: %Schema{type: :string}}}
...> |> Schema.required(:phone_number)
%PhoenixSwagger.Schema{
  type: :object,
  properties: %{
    phone_number: %PhoenixSwagger.Schema{
      type: :string
    }
  },
  required: [:phone_number]
}

iex> alias PhoenixSwagger.Schema
...> %Schema{type: :object, properties: %{phone_number: %Schema{type: :string}, address: %Schema{type: :string}}}
...> |> Schema.required([:phone_number, :address])
%PhoenixSwagger.Schema{
  type: :object,
  properties: %{
    phone_number: %PhoenixSwagger.Schema{
      type: :string
    },
    address: %PhoenixSwagger.Schema{
      type: :string
    }
  },
  required: [:phone_number, :address]
}