View Source GitHub.Git (GitHub REST API Client v0.0.4)
Provides API endpoints related to git
Link to this section Summary
Functions
Create a blob
Create a commit
Create a reference
Create a tag object
Create a tree
Delete a reference
Get a blob
Get a commit
Get a reference
Get a tree
List matching references
Update a reference
Link to this section Functions
@spec create_blob(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.ShortBlob.t()} | {:error, GitHub.Error.t()}
Create a blob
resources
Resources
@spec create_commit(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Git.Commit.t()} | {:error, GitHub.Error.t()}
Create a commit
resources
Resources
@spec create_ref(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Git.Ref.t()} | {:error, GitHub.Error.t()}
Create a reference
resources
Resources
@spec create_tag(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Git.Tag.t()} | {:error, GitHub.Error.t()}
Create a tag object
resources
Resources
@spec create_tree(String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Git.Tree.t()} | {:error, GitHub.Error.t()}
Create a tree
resources
Resources
@spec delete_ref(String.t(), String.t(), String.t(), keyword()) :: :ok | {:error, GitHub.Error.t()}
Delete a reference
resources
Resources
@spec get_blob(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Blob.t()} | {:error, GitHub.Error.t()}
Get a blob
resources
Resources
@spec get_commit(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Git.Commit.t()} | {:error, GitHub.Error.t()}
Get a commit
resources
Resources
@spec get_ref(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Git.Ref.t()} | {:error, GitHub.Error.t()}
Get a reference
resources
Resources
@spec get_tag(String.t(), String.t(), String.t(), keyword()) :: {:ok, GitHub.Git.Tag.t()} | {:error, GitHub.Error.t()}
Get a tag
resources
Resources
@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, settingrecursive
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
@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
@spec update_ref(String.t(), String.t(), String.t(), map(), keyword()) :: {:ok, GitHub.Git.Ref.t()} | {:error, GitHub.Error.t()}
Update a reference