defmodule OpenApiSpex.ExternalDocumentation do
  @moduledoc """
  Defines the `OpenApiSpex.ExternalDocumentation.t` type.
  """

  @enforce_keys :url
  defstruct [
    :description,
    :url,
    :extensions
  ]

  @typedoc """
  [External Documentation Object](https://swagger.io/specification/#externalDocumentationObject)

  Allows referencing an external resource for extended documentation.
  """
  @type t :: %__MODULE__{
          description: String.t() | nil,
          url: String.t(),
          extensions: %{String.t() => any()} | nil
        }
end