open_api_spex v3.4.0 OpenApiSpex.Info View Source
Defines the OpenApiSpex.Info.t type.
Link to this section Summary
Link to this section Types
Link to this type
t()
View Source
t()
View Source
t() :: %OpenApiSpex.Info{
contact: OpenApiSpex.Contact.t() | nil,
description: String.t() | nil,
extensions: %{optional(String.t()) => String.t()} | nil,
license: OpenApiSpex.License.t() | nil,
termsOfService: String.t() | nil,
title: String.t(),
version: String.t()
}
t() :: %OpenApiSpex.Info{
contact: OpenApiSpex.Contact.t() | nil,
description: String.t() | nil,
extensions: %{optional(String.t()) => String.t()} | nil,
license: OpenApiSpex.License.t() | nil,
termsOfService: String.t() | nil,
title: String.t(),
version: String.t()
}
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.