View Source OpenApiSpex.ExternalDocumentation (open_api_spex v3.21.1)

Defines the OpenApiSpex.ExternalDocumentation.t type.

Summary

Types

t()

External Documentation Object

Types

Link to this type

t()

View Source 
@type t() :: %OpenApiSpex.ExternalDocumentation{
  description: String.t() | nil,
  extensions: %{required(String.t()) => any()} | nil,
  url: String.t()
}

External Documentation Object

Allows referencing an external resource for extended documentation.