View Source GitHub.Meta (GitHub REST API Client v0.3.3)
Provides API endpoints related to meta
Link to this section Summary
Functions
Get GitHub meta information
Get all API versions
Get Octocat
Get the Zen of GitHub
GitHub API Root
Link to this section Functions
@spec get(keyword()) :: {:ok, GitHub.ApiOverview.t()} | {:error, GitHub.Error.t()}
Get GitHub meta information
Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see "About GitHub's IP addresses."
The API's response also includes a list of GitHub's domain names.
The values shown in the documentation's response are example values. You must always query the API directly to get the latest values.
Note: This endpoint returns both IPv4 and IPv6 addresses. However, not all features support IPv6. You should refer to the specific documentation for each feature to determine if IPv6 is supported.
resources
Resources
@spec get_all_versions(keyword()) :: {:ok, [Date.t()]} | {:error, GitHub.Error.t()}
Get all API versions
Get all supported GitHub API versions.
resources
Resources
@spec get_octocat(keyword()) :: {:ok, String.t()} | {:error, GitHub.Error.t()}
Get Octocat
Get the octocat as ASCII art
options
Options
s
: The words to show in Octocat's speech bubble
resources
Resources
@spec get_zen(keyword()) :: {:ok, String.t()} | {:error, GitHub.Error.t()}
Get the Zen of GitHub
Get a random sentence from the Zen of GitHub
resources
Resources
@spec root(keyword()) :: {:ok, GitHub.Root.t()} | {:error, GitHub.Error.t()}
GitHub API Root
Get Hypermedia links to resources accessible in GitHub's REST API