View Source Tentacat.Commits.Comments (Tentacat v2.5.0)

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

Link to this function

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

View Source
@spec create(Tentacat.Client.t(), binary(), binary(), binary(), map()) ::
  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

Link to this function

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

View Source
@spec 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

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source
@spec 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

Link to this function

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

View Source
@spec update(Tentacat.Client.t(), binary(), binary(), binary() | integer(), map()) ::
  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