Current section

Files

Jump to
open_api_spex lib open_api_spex server_variable.ex
Raw

lib/open_api_spex/server_variable.ex

defmodule OpenApiSpex.ServerVariable do
@moduledoc """
Defines the `OpenApiSpex.ServerVariable.t` type.
"""
@enforce_keys :default
defstruct [
:enum,
:default,
:description
]
@typedoc """
[Server Variable Object](https://swagger.io/specification/#serverVariableObject)
An object representing a Server Variable for server URL template substitution.
"""
@type t :: %__MODULE__{
enum: [String.t] | nil,
default: String.t,
description: String.t | nil
}
end