Tentacat

v0.7.2

Tentacat v0.7.2 Tentacat.Issues

Summary

Functions

create(owner, repo, body, client \\ %Tentacat.Client{})

Create an issue

filter(owner, repo, filters, client \\ %Tentacat.Client{})

Filter issues

find(owner, repo, number, client \\ %Tentacat.Client{})

Get a single issue

list(owner, repo, client \\ %Tentacat.Client{})

List issues

update(owner, repo, number, body, client \\ %Tentacat.Client{})

Update an issue

Functions

create(owner, repo, body, client \\ %Tentacat.Client{})

Specs

create(binary, binary, list | map, Tentacat.Client.t) :: Tentacat.response

Create an issue

Possible values for body:

  • [title: "title of issue"] (required)
  • [body: "body of issue"]
  • [assignee: "username"]
  • [milestone: 4]
  • [labels: ["bug", "frontend"]]

Example

Tentacat.Issues.create "elixir-lang", "elixir", %{"title" => "Issue", "body" => "Details"}
Tentacat.Issues.create "elixir-lang", "elixir", %{"title" => "Issue", "body" => "Details"}, client

More info at: https://developer.github.com/v3/issues/#create-an-issue

filter(owner, repo, filters, client \\ %Tentacat.Client{})

Specs

filter(binary, binary, map, Tentacat.Client.t) :: Tentacat.response

Filter issues

Example

Tentacat.Issues.filter "elixir-lang", "elixir", %{state: "open"}
Tentacat.Issues.filter "elixir-lang", "elixir", %{state: "open"}, client

More info at: https://developer.github.com/v3/issues/#list-issues-for-a-repository

find(owner, repo, number, client \\ %Tentacat.Client{})

Specs

find(binary, binary, binary | integer, Tentacat.Client.t) :: Tentacat.response

Get a single issue

Example

Tentacat.Issues.find "elixir-lang", "elixir", "2974"
Tentacat.Issues.find "elixir-lang", "elixir", "2974", client

More info at: https://developer.github.com/v3/issues/#get-a-single-issue

list(owner, repo, client \\ %Tentacat.Client{})

Specs

list(binary, binary, Tentacat.Client.t) :: Tentacat.response

List issues

Example

Tentacat.Issues.list "elixir-lang", "elixir"
Tentacat.Issues.list "elixir-lang", "elixir", client

More info at: https://developer.github.com/v3/issues/#list-issues

update(owner, repo, number, body, client \\ %Tentacat.Client{})

Specs

update(binary, binary, binary | integer, list | map, Tentacat.Client.t) :: Tentacat.response

Update an issue

Possible values for body:

  • [title: "title of issue"]
  • [body: "body of issue"]
  • [assignee: "username"]
  • [state: "closed"]
  • [milestone: 4]
  • [labels: ["bug", "frontend"]]

Example

Tentacat.Issues.update "elixir-lang", "elixir", "2974", %{"assignee" => "edgurgel"}
Tentacat.Issues.update "elixir-lang", "elixir", "2974", %{"state" => "closed"}, client

More info at: https://developer.github.com/v3/issues/#edit-an-issue