gogs v1.1.0

Gogs.Http (gogs v1.1.0)

Documentation for the HTTP "verb" functions. Should be self-explanatory. Each function documented & typespecd.
If anything is unclear, please open an issue: github.com/dwyl/gogs/issues

Link to this section Summary

Functions

delete(url)

delete/1 accepts a single argument url; the url for the repository to be deleted.

get(url)

get/1 accepts one argument: url the REST API endpoint. Makes an HTTP GET request to the specified url. Auth Headers and Content-Type are implicit. returns {:ok, map}

get_raw(url)

get_raw/1 as it's name suggests gets the raw data (expects the reponse to be plaintext not JSON) accepts one argument: url the REST API endpoint. Makes an HTTP GET request to the specified url. Auth Headers and Content-Type are implicit. returns {:ok, map}

inject_poison()

inject_poison/0 injects a TestDouble of HTTPoison in Test. see: https://github.com/dwyl/elixir-auth-google/issues/35

parse_body_response(arg)

parse_body_response/1 parses the response returned by the Gogs Server so your app can use the resulting JSON.

post(url, params \\ %{})

post/2 accepts two arguments: url and params. Makes an HTTP POST request to the specified url passing in the params as the request body. Auth Headers and Content-Type are implicit.

post_raw_html(url, raw_markdown)

post_raw_html/2 accepts two arguments: url and raw_markdown. Makes an HTTP POST request to the specified url passing in the params as the request body. Does NOT attempt to parse the response body as JSON. Auth Headers and Content-Type are implicit.

Link to this section Functions

Link to this function

delete(url)

@spec delete(String.t()) :: {:ok, map()} | {:error, any()}

delete/1 accepts a single argument url; the url for the repository to be deleted.

Link to this function

get(url)

@spec get(String.t()) :: {:ok, map()} | {:error, any()}

get/1 accepts one argument: url the REST API endpoint. Makes an HTTP GET request to the specified url. Auth Headers and Content-Type are implicit. returns {:ok, map}

Link to this function

get_raw(url)

@spec get_raw(String.t()) :: {:ok, map()} | {:error, any()}

get_raw/1 as it's name suggests gets the raw data (expects the reponse to be plaintext not JSON) accepts one argument: url the REST API endpoint. Makes an HTTP GET request to the specified url. Auth Headers and Content-Type are implicit. returns {:ok, map}

Link to this function

inject_poison()

inject_poison/0 injects a TestDouble of HTTPoison in Test. see: https://github.com/dwyl/elixir-auth-google/issues/35

Link to this function

parse_body_response(arg)

@spec parse_body_response({atom(), String.t()} | {:error, any()}) ::
  {:ok, map()} | {:error, any()}

parse_body_response/1 parses the response returned by the Gogs Server so your app can use the resulting JSON.

Link to this function

post(url, params \\ %{})

@spec post(String.t(), map()) :: {:ok, map()} | {:error, any()}

post/2 accepts two arguments: url and params. Makes an HTTP POST request to the specified url passing in the params as the request body. Auth Headers and Content-Type are implicit.

Link to this function

post_raw_html(url, raw_markdown)

@spec post_raw_html(String.t(), String.t()) :: {:ok, String.t()} | {:error, any()}

post_raw_html/2 accepts two arguments: url and raw_markdown. Makes an HTTP POST request to the specified url passing in the params as the request body. Does NOT attempt to parse the response body as JSON. Auth Headers and Content-Type are implicit.