View Source GitHub.Git (GitHub REST API Client v0.0.6)

Provides API endpoints related to git

Link to this section Summary

Link to this section Functions

Link to this function

create_blob(owner, repo, body, opts \\ [])

View Source
@spec create_blob(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.ShortBlob.t()} | {:error, GitHub.Error.t()}

Create a blob

resources

Resources

Link to this function

create_commit(owner, repo, body, opts \\ [])

View Source
@spec create_commit(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Git.Commit.t()} | {:error, GitHub.Error.t()}

Create a commit

resources

Resources

Link to this function

create_ref(owner, repo, body, opts \\ [])

View Source
@spec create_ref(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Git.Ref.t()} | {:error, GitHub.Error.t()}

Create a reference

resources

Resources

Link to this function

create_tag(owner, repo, body, opts \\ [])

View Source
@spec create_tag(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Git.Tag.t()} | {:error, GitHub.Error.t()}

Create a tag object

resources

Resources

Link to this function

create_tree(owner, repo, body, opts \\ [])

View Source
@spec create_tree(String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Git.Tree.t()} | {:error, GitHub.Error.t()}

Create a tree

resources

Resources

Link to this function

delete_ref(owner, repo, ref, opts \\ [])

View Source
@spec delete_ref(String.t(), String.t(), String.t(), keyword()) ::
  :ok | {:error, GitHub.Error.t()}

Delete a reference

resources

Resources

Link to this function

get_blob(owner, repo, file_sha, opts \\ [])

View Source
@spec get_blob(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Blob.t()} | {:error, GitHub.Error.t()}

Get a blob

resources

Resources

Link to this function

get_commit(owner, repo, commit_sha, opts \\ [])

View Source
@spec get_commit(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Git.Commit.t()} | {:error, GitHub.Error.t()}

Get a commit

resources

Resources

Link to this function

get_ref(owner, repo, ref, opts \\ [])

View Source
@spec get_ref(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Git.Ref.t()} | {:error, GitHub.Error.t()}

Get a reference

resources

Resources

Link to this function

get_tag(owner, repo, tag_sha, opts \\ [])

View Source
@spec get_tag(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Git.Tag.t()} | {:error, GitHub.Error.t()}

Get a tag

resources

Resources

Link to this function

get_tree(owner, repo, tree_sha, opts \\ [])

View Source
@spec get_tree(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, GitHub.Git.Tree.t()} | {:error, GitHub.Error.t()}

Get a tree

options

Options

  • recursive (String.t()): Setting this parameter to any value returns the objects or subtrees referenced by the tree specified in :tree_sha. For example, setting recursive to any of the following will enable returning objects or subtrees: 0, 1, "true", and "false". Omit this parameter to prevent recursively returning objects or subtrees.

resources

Resources

Link to this function

list_matching_refs(owner, repo, ref, opts \\ [])

View Source
@spec list_matching_refs(String.t(), String.t(), String.t(), keyword()) ::
  {:ok, [GitHub.Git.Ref.t()]} | {:error, GitHub.Error.t()}

List matching references

resources

Resources

Link to this function

update_ref(owner, repo, ref, body, opts \\ [])

View Source
@spec update_ref(String.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, GitHub.Git.Ref.t()} | {:error, GitHub.Error.t()}

Update a reference

resources

Resources