AsyncApiSpex.Document (async_api_spex v0.1.0)

Copy Markdown View Source

An AsyncAPI 3.0 document.

The top-level object. asyncapi is fixed to "3.0.0". servers, channels, and operations are maps keyed by the id used to reference them from elsewhere in the document. components holds reusable objects extracted by AsyncApiSpex.resolve/1.

Summary

Types

t()

Types

t()

@type t() :: %AsyncApiSpex.Document{
  asyncapi: String.t(),
  channels: %{optional(String.t()) => AsyncApiSpex.Channel.t()},
  components: AsyncApiSpex.Components.t(),
  default_content_type: String.t() | nil,
  extensions: map(),
  id: String.t() | nil,
  info: AsyncApiSpex.Info.t() | nil,
  operations: %{optional(String.t()) => AsyncApiSpex.Operation.t()},
  servers: %{optional(String.t()) => AsyncApiSpex.Server.t()}
}