APIDoc v0.1.3 APIDoc.Doc.Server View Source

Server URL and description for .

Examples

Only URL:

%Server{url: "https://prod.example.com"}

URL and description:

%Server{
  url:  "https://prod.example.com",
  description: "Production example server"
}

Link to this section Summary

Types

t()

Server URL and description for .

Link to this section Types

Link to this type

t() View Source
t() :: %APIDoc.Doc.Server{description: String.t() | nil, url: String.t()}

Server URL and description for .

Examples

Only URL:

%Server{url: "https://prod.example.com"}

URL and description:

%Server{
  url:  "https://prod.example.com",
  description: "Production example server"
}