Get instance information

master
Milton Mazzarri 2017-04-10 21:44:11 -05:00
parent 08eb4b4d14
commit e42e4b1f23
No known key found for this signature in database
GPG Key ID: CF3DE6E356E17F1E
1 changed files with 16 additions and 0 deletions

View File

@ -13,6 +13,8 @@ defmodule Hunter.Instance do
* `email` - An email address which can be used to contact the instance administrator
"""
@hunter_api Application.get_env(:hunter, :hunter_api)
@type t :: %__MODULE__{
uri: URI.t,
title: String.t,
@ -20,5 +22,19 @@ defmodule Hunter.Instance do
email: String.t
}
@derive [Poison.Encoder]
defstruct [:uri, :title, :description, :email]
@doc """
Retrieve instance information
## Parameters
* `conn` - connection credentials
"""
@spec instance_info(Hunter.Client.t) :: Hunter.Instance.t
def instance_info(conn) do
@hunter_api.instance_info(conn)
end
end