Current section
4 Versions
Jump to
Current section
4 Versions
Compare versions
4
files changed
+22
additions
-4
deletions
| @@ -29,4 +29,4 @@ | |
| 29 29 | {<<"optional">>,false}, |
| 30 30 | {<<"repository">>,<<"hexpm">>}, |
| 31 31 | {<<"requirement">>,<<"0.10.0">>}]]}. |
| 32 | - {<<"version">>,<<"0.1.1">>}. |
| 32 | + {<<"version">>,<<"0.1.2">>}. |
| @@ -1,6 +1,14 @@ | |
| 1 1 | defmodule Graphito.Response.Error do |
| 2 | - @moduledoc false |
| 2 | + @moduledoc """ |
| 3 | + A graphito error reponse. |
| 4 | + """ |
| 3 5 | |
| 6 | + @typedoc """ |
| 7 | + Error information for a GraphQL operation: |
| 8 | + |
| 9 | + - reason: A non GraphQL realted error, for example a server HTTP code error. |
| 10 | + - errors: The list of errors sent by the GraphQL server. |
| 11 | + """ |
| 4 12 | @type t :: %__MODULE__{ |
| 5 13 | reason: any(), |
| 6 14 | errors: list(String.t()) |
| @@ -1,8 +1,18 @@ | |
| 1 1 | defmodule Graphito.Response do |
| 2 | - @moduledoc false |
| 2 | + @moduledoc """ |
| 3 | + Reponse from a GraphQL request. |
| 4 | + """ |
| 3 5 | |
| 4 6 | alias Graphito.Response.Error |
| 5 7 | |
| 8 | + @typedoc """ |
| 9 | + The response finormation from a GraphQL operation: |
| 10 | + |
| 11 | + - data: The data response |
| 12 | + - errors: The errors response |
| 13 | + - status: The HTTP status from the server response |
| 14 | + - headers: The HTTP headers sent in the server response |
| 15 | + """ |
| 6 16 | @type t :: %__MODULE__{ |
| 7 17 | data: map(), |
| 8 18 | status: non_neg_integer, |
| @@ -1,7 +1,7 @@ | |
| 1 1 | defmodule Graphito.MixProject do |
| 2 2 | use Mix.Project |
| 3 3 | |
| 4 | - @version "0.1.1" |
| 4 | + @version "0.1.2" |
| 5 5 | |
| 6 6 | def project do |
| 7 7 | [ |