Tentacat v1.2.0 Tentacat.Repositories.Labels

Summary

Functions

Creates a new label on a repository

Delete a label on a repository

Find a label on a repository

List labels on a repository

Functions

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

Specs

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

Creates a new label on a repository

Possible values for body:

  • [name: "name of label"] (required)
  • [color: "color of label"] (required)

Example

Tentacat.Repositories.Labels.create "elixir-lang", "elixir", %{name: "Important", color: "f29513"}

More info at: https://developer.github.com/v3/issues/labels/#create-a-label

delete(client \\ %Client{}, owner, repo, name)

Specs

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

Delete a label on a repository

Example

Tentacat.Repositories.Labels.delete "elixir-lang", "elixir", "Important"

More info at: https://developer.github.com/v3/issues/labels/#delete-a-label

find(client \\ %Client{}, owner, repo, name)

Specs

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

Find a label on a repository

Example

Tentacat.Repositories.Labels.find "elixir-lang", "elixir", "WIP"

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

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

Specs

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

List labels on a repository

Example

Tentacat.Repositories.Labels.list "elixir-lang", "elixir"

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

update(client \\ %Client{}, owner, repo, name, body)

Specs

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

Update a label on a repository

Possible values for body:

  • [name: "name of label"] (required)
  • [color: "color of label"] (required)

Example

Tentacat.Repositories.Labels.update "elixir-lang", "elixir", "Important", %{color: "000000"}

More info at: https://developer.github.com/v3/issues/labels/#update-a-label