Module git_api

Source

Enums§

GitSlashCreateBlobError
struct for typed errors of method git_slash_create_blob
GitSlashCreateCommitError
struct for typed errors of method git_slash_create_commit
GitSlashCreateRefError
struct for typed errors of method git_slash_create_ref
GitSlashCreateTagError
struct for typed errors of method git_slash_create_tag
GitSlashCreateTreeError
struct for typed errors of method git_slash_create_tree
GitSlashDeleteRefError
struct for typed errors of method git_slash_delete_ref
GitSlashGetBlobError
struct for typed errors of method git_slash_get_blob
GitSlashGetCommitError
struct for typed errors of method git_slash_get_commit
GitSlashGetRefError
struct for typed errors of method git_slash_get_ref
GitSlashGetTagError
struct for typed errors of method git_slash_get_tag
GitSlashGetTreeError
struct for typed errors of method git_slash_get_tree
GitSlashListMatchingRefsError
struct for typed errors of method git_slash_list_matching_refs
GitSlashUpdateRefError
struct for typed errors of method git_slash_update_ref

Functions§

git_slash_create_blob
git_slash_create_commit
Creates a new Git commit object. Signature verification object The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object: | Name | Type | Description | | –– | –– | ———– | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | signature | string | The signature that was extracted from the commit. | | payload | string | The value that was signed. | These are the possible values for reason in the verification object: | Value | Description | | —– | ———– | | expired_key | The key that made the signature is expired. | | not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | gpgverify_error | There was an error communicating with the signature verification service. | | gpgverify_unavailable | The signature verification service is currently unavailable. | | unsigned | The object does not include a signature. | | unknown_signature_type | A non-PGP signature was found in the commit. | | no_user | No user was associated with the committer email address in the commit. | | unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. | | bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. | | unknown_key | The key that made the signature has not been registered with any user’s account. | | malformed_signature | There was an error parsing the signature. | | invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | valid | None of the above errors applied, so the signature is considered to be verified. |
git_slash_create_ref
Creates a reference for your repository. You are unable to create new references for empty repositories, even if the commit SHA-1 hash used exists. Empty repositories are repositories without branches.
git_slash_create_tag
Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the refs/tags/[tag] reference. If you want to create a lightweight tag, you only have to create the tag reference - this call would be unnecessary. Signature verification object The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object: | Name | Type | Description | | –– | –– | ———– | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. | | signature | string | The signature that was extracted from the commit. | | payload | string | The value that was signed. | These are the possible values for reason in the verification object: | Value | Description | | —– | ———– | | expired_key | The key that made the signature is expired. | | not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | gpgverify_error | There was an error communicating with the signature verification service. | | gpgverify_unavailable | The signature verification service is currently unavailable. | | unsigned | The object does not include a signature. | | unknown_signature_type | A non-PGP signature was found in the commit. | | no_user | No user was associated with the committer email address in the commit. | | unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. | | bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. | | unknown_key | The key that made the signature has not been registered with any user’s account. | | malformed_signature | There was an error parsing the signature. | | invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | valid | None of the above errors applied, so the signature is considered to be verified. |
git_slash_create_tree
The tree creation API accepts nested entries. If you specify both a tree and a nested path modifying that tree, this endpoint will overwrite the contents of the tree with the new path contents, and create a new tree structure. If you use this endpoint to add, delete, or modify the file contents in a tree, you will need to commit the tree and then update a branch to point to the commit. For more information see "Create a commit" and "Update a reference." Returns an error if you try to delete a file that does not exist.
git_slash_delete_ref
Deletes the provided reference.
git_slash_get_blob
The content in the response will always be Base64 encoded. This endpoint supports the following custom media types. For more information, see "Media types." - application/vnd.github.raw+json: Returns the raw blob data. - application/vnd.github+json: Returns a JSON representation of the blob with content as a base64 encoded string. This is the default if no media type is specified. Note This endpoint supports blobs up to 100 megabytes in size.
git_slash_get_commit
Gets a Git commit object. To get the contents of a commit, see "Get a commit." Signature verification object The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object: | Name | Type | Description | | –– | –– | ———– | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verified value. Possible values and their meanings are enumerated in the table below. | | signature | string | The signature that was extracted from the commit. | | payload | string | The value that was signed. | These are the possible values for reason in the verification object: | Value | Description | | —– | ———– | | expired_key | The key that made the signature is expired. | | not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | gpgverify_error | There was an error communicating with the signature verification service. | | gpgverify_unavailable | The signature verification service is currently unavailable. | | unsigned | The object does not include a signature. | | unknown_signature_type | A non-PGP signature was found in the commit. | | no_user | No user was associated with the committer email address in the commit. | | unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. | | bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. | | unknown_key | The key that made the signature has not been registered with any user’s account. | | malformed_signature | There was an error parsing the signature. | | invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | valid | None of the above errors applied, so the signature is considered to be verified. |
git_slash_get_ref
Returns a single reference from your Git database. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t match an existing ref, a 404 is returned. Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests".
git_slash_get_tag
Signature verification object The response will include a verification object that describes the result of verifying the commit’s signature. The following fields are included in the verification object: | Name | Type | Description | | –– | –– | ———– | | verified | boolean | Indicates whether GitHub considers the signature in this commit to be verified. | | reason | string | The reason for verified value. Possible values and their meanings are enumerated in table below. | | signature | string | The signature that was extracted from the commit. | | payload | string | The value that was signed. | These are the possible values for reason in the verification object: | Value | Description | | —– | ———– | | expired_key | The key that made the signature is expired. | | not_signing_key | The "signing" flag is not among the usage flags in the GPG key that made the signature. | | gpgverify_error | There was an error communicating with the signature verification service. | | gpgverify_unavailable | The signature verification service is currently unavailable. | | unsigned | The object does not include a signature. | | unknown_signature_type | A non-PGP signature was found in the commit. | | no_user | No user was associated with the committer email address in the commit. | | unverified_email | The committer email address in the commit was associated with a user, but the email address is not verified on their account. | | bad_email | The committer email address in the commit is not included in the identities of the PGP key that made the signature. | | unknown_key | The key that made the signature has not been registered with any user’s account. | | malformed_signature | There was an error parsing the signature. | | invalid | The signature could not be cryptographically verified using the key whose key-id was found in the signature. | | valid | None of the above errors applied, so the signature is considered to be verified. |
git_slash_get_tree
Returns a single tree using the SHA1 value or ref name for that tree. If truncated is true in the response then the number of items in the tree array exceeded our maximum limit. If you need to fetch more items, use the non-recursive method of fetching trees, and fetch one sub-tree at a time. Note: The limit for the tree array is 100,000 entries with a maximum size of 7 MB when using the recursive parameter.
git_slash_list_matching_refs
Returns an array of references from your Git database that match the supplied name. The :ref in the URL must be formatted as heads/<branch name> for branches and tags/<tag name> for tags. If the :ref doesn’t exist in the repository, but existing refs start with :ref, they will be returned as an array. When you use this endpoint without providing a :ref, it will return an array of all the references from your Git database, including notes and stashes if they exist on the server. Anything in the namespace is returned, not just heads and tags. Note: You need to explicitly request a pull request to trigger a test merge commit, which checks the mergeability of pull requests. For more information, see "Checking mergeability of pull requests". If you request matching references for a branch named feature but the branch feature doesn’t exist, the response can still include other matching head refs that start with the word feature, such as featureA and featureB.
git_slash_update_ref
Updates the provided reference to point to a new SHA. For more information, see "Git References" in the Git documentation.