Tentacat v1.2.0 Tentacat.Commits.Comments

Summary

Functions

Delete a comment for a commit

Find a comment for a commit

List commit comments for a commit

List commit comments in a repository

Functions

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

Specs

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

Create a comment for a commit

Comment body example:

%{
  "body"      => "Nice change",
  "path"      => "file1.txt",
  "position"  => 4,
  "line"      => null
}

Example

Tentacat.Commits.Comments.create "elixir-lang", "elixir", "7491bda5196f78536e5acc9b7c90a97170e4db0a", comment_body

More info at: https://developer.github.com/v3/repos/comments/#create-a-commit-comment

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

Specs

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

Delete a comment for a commit

Example

Tentacat.Commits.Comments.delete "elixir-lang", "elixir", 1

More info at: https://developer.github.com/v3/repos/comments/#delete-a-commit-comment

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

Specs

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

Find a comment for a commit

Example

Tentacat.Commits.Comments.find "elixir-lang", "elixir", 1

More info at: https://developer.github.com/v3/repos/comments/#get-a-single-commit-comment

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

Specs

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

List commit comments for a commit

Example

Tentacat.Commits.Comments.list "elixir-lang", "elixir", "7491bda5196f78536e5acc9b7c90a97170e4db0a"

More info at: https://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit

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

Specs

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

List commit comments in a repository

Example

Tentacat.Commits.Comments.list_all "elixir-lang", "elixir"

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

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

Specs

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

Update a comment for a commit

Comment body example:

%{
  "body"      => "Nice change",
}

Example

Tentacat.Commits.Comments.update "elixir-lang", "elixir", 1

More info at: https://developer.github.com/v3/repos/comments/#update-a-commit-comment