Tentacat v2.2.0 Tentacat.Issues View Source
Link to this section Summary
Functions
Create an issue
Filter repository issues
Get an issue
List repository issues
Update an issue
Link to this section Functions
Link to this function
create(client \\ %Client{}, owner, repo, body)
View Sourcecreate(Tentacat.Client.t(), binary(), binary(), map()) :: 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 client, "elixir-lang", "elixir", %{"title" => "Issue", "body" => "Details"}
More info at: https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#create-an-issue
Link to this function
filter(client \\ %Client{}, owner, repo, filters)
View Sourcefilter(Tentacat.Client.t(), binary(), binary(), map()) :: Tentacat.response()
Filter repository issues
Example
Tentacat.Issues.filter "elixir-lang", "elixir", %{state: "open"}
Tentacat.Issues.filter client, "elixir-lang", "elixir", %{state: "open"}
More info at: https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-repository-issues
Link to this function
find(client \\ %Client{}, owner, repo, number)
View Sourcefind(Tentacat.Client.t(), binary(), binary(), binary() | integer()) :: Tentacat.response()
Get an issue
Example
Tentacat.Issues.find "elixir-lang", "elixir", "2974"
Tentacat.Issues.find client, "elixir-lang", "elixir", "2974"
More info at: https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#get-an-issue
Link to this function
list(client \\ %Client{}, owner, repo)
View Sourcelist(Tentacat.Client.t(), binary(), binary()) :: Tentacat.response()
List repository issues
Example
Tentacat.Issues.list "elixir-lang", "elixir"
Tentacat.Issues.list client, "elixir-lang", "elixir"
More info at: https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#list-repository-issues
Link to this function
update(client \\ %Client{}, owner, repo, number, body)
View Sourceupdate(Tentacat.Client.t(), binary(), binary(), binary() | integer(), map()) :: 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 client, "elixir-lang", "elixir", "2974", %{"state" => "closed"}
More info at: https://docs.github.com/en/free-pro-team@latest/rest/reference/issues#update-an-issue