GhEx.REST.Meta (gh_ex v0.1.0)

Copy Markdown View Source

Metadata accompanying a successful REST response.

  • :status - the HTTP status code.
  • :headers - the raw response headers, as returned by Req.
  • :links - parsed pagination links, e.g. %{"next" => url, "last" => url}. Empty when the endpoint is not paginated.
  • :rate_limit - a GhEx.RateLimit snapshot, or nil if the headers were absent.

Summary

Types

t()

Types

t()

@type t() :: %GhEx.REST.Meta{
  headers: map() | list(),
  links: %{optional(String.t()) => String.t()},
  rate_limit: GhEx.RateLimit.t() | nil,
  status: pos_integer() | nil
}