AsyncApiSpex.Components (async_api_spex v0.1.0)

Copy Markdown View Source

Reusable objects referenced from elsewhere in the document.

Keys are the component names; AsyncApiSpex.resolve/1 fills schemas and messages from use AsyncApiSpex.Schema and use AsyncApiSpex.Message declarations.

Summary

Types

t()

Types

t()

@type t() :: %AsyncApiSpex.Components{
  channels: %{optional(String.t()) => AsyncApiSpex.Channel.t()},
  correlation_ids: %{optional(String.t()) => AsyncApiSpex.CorrelationId.t()},
  extensions: map(),
  messages: %{optional(String.t()) => AsyncApiSpex.Message.t()},
  operations: %{optional(String.t()) => AsyncApiSpex.Operation.t()},
  parameters: %{optional(String.t()) => AsyncApiSpex.Parameter.t()},
  schemas: %{optional(String.t()) => map()},
  servers: %{optional(String.t()) => AsyncApiSpex.Server.t()}
}