open_api_spex v3.18.0

View Source OpenApiSpex.Info (open_api_spex v3.18.0)

Defines the OpenApiSpex.Info.t type.

Link to this section Summary

Types

t()

Info Object

Link to this section Types

Link to this type

t()

View Source 
@type t() :: %OpenApiSpex.Info{
  contact: OpenApiSpex.Contact.t() | nil,
  description: String.t() | nil,
  extensions: %{required(String.t()) => any()} | nil,
  license: OpenApiSpex.License.t() | nil,
  termsOfService: String.t() | nil,
  title: String.t(),
  version: String.t()
}

Info Object

The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience.