Phoenix API Versions v1.1.0 PhoenixApiVersions.Version View Source

A struct representing a distinct version of a JSON API in a Phoenix application.

`name`

The name of a Version is very important.

When a consumer visits a version of a JSON API (say “v2”), PhoenixApiVersions will not recognize unless the name exactly matches what is returned by the Versions module in the PhoenixApiVersions.version_name/1 callback.

Link to this section Summary

Types

t()

Link to this section Types

t()

t() :: %PhoenixApiVersions.Version{
  changes: [module()],
  name: String.t() | atom()
}