Referências do Git - GitHub Enterprise Server 3.1 Docs

A API de referências do Git permite ler e escrever referências para o banco de dados do Git em GitHub Enterprise Server

Sobre a API de referências do Git

Uma referência do Git (git ref) é um arquivo que contém um hash SHA-1 do commit do Git. Ao fazer referência a um commit do Git, você pode usar a referência do Git, que é um nome fácil de lembrar, em vez do hash. A referência do Git pode ser reescrita para apontar para um novo commit. Uma branch é uma referência Git que armazena o novo hash de commit do Git. Estes pontos de extremidade permitem ler e escrever referências para o seu banco de dados do Git em GitHub Enterprise Server.

List matching references

Works with GitHub Apps

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.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`owner`stringObrigatório The account owner of the repository. The name is not case sensitive.
`repo`stringObrigatório The name of the repository. The name is not case sensitive.
`ref`stringObrigatório ref parameter
Parâmetros de consulta
Nome, Tipo, Descrição
`per_page`integer The number of results per page (max 100). Padrão: `30`
`page`integer Page number of the results to fetch. Padrão: `1`

HTTP response status codes

Status code	Descrição
`200`	OK

Amostras de código

get/repos/{owner}/{repo}/git/matching-refs/{ref}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/matching-refs/REF

Response

Status: 200

[
  {
    "ref": "refs/heads/feature-a",
    "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWE=",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-a",
    "object": {
      "type": "commit",
      "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
      "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
    }
  },
  {
    "ref": "refs/heads/feature-b",
    "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlLWI=",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/feature-b",
    "object": {
      "type": "commit",
      "sha": "612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac",
      "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/612077ae6dffb4d2fbd8ce0cccaa58893b07b5ac"
    }
  }
]

Get a reference

Works with GitHub Apps

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.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`owner`stringObrigatório The account owner of the repository. The name is not case sensitive.
`repo`stringObrigatório The name of the repository. The name is not case sensitive.
`ref`stringObrigatório ref parameter

HTTP response status codes

Status code	Descrição
`200`	OK
`404`	Resource not found

Amostras de código

get/repos/{owner}/{repo}/git/ref/{ref}

curl \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/ref/REF

Response

Status: 200

{
  "ref": "refs/heads/featureA",
  "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==",
  "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
  "object": {
    "type": "commit",
    "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
  }
}

Create a reference

Works with GitHub Apps

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.

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`owner`stringObrigatório The account owner of the repository. The name is not case sensitive.
`repo`stringObrigatório The name of the repository. The name is not case sensitive.
Body parameters
Nome, Tipo, Descrição
`ref`stringObrigatório The name of the fully qualified reference (ie: `refs/heads/master`). If it doesn't start with 'refs' and have at least two slashes, it will be rejected.
`sha`stringObrigatório The SHA1 value for this reference.
`key`string

HTTP response status codes

Status code	Descrição
`201`	Created
`422`	Validation failed

Amostras de código

post/repos/{owner}/{repo}/git/refs

curl \
  -X POST \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/refs \
  -d '{"ref":"refs/heads/featureA","sha":"aa218f56b14c9653891f9e74264a383fa43fefbd"}'

Response

Status: 201

{
  "ref": "refs/heads/featureA",
  "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==",
  "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
  "object": {
    "type": "commit",
    "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
  }
}

Update a reference

Works with GitHub Apps

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`owner`stringObrigatório The account owner of the repository. The name is not case sensitive.
`repo`stringObrigatório The name of the repository. The name is not case sensitive.
`ref`stringObrigatório ref parameter
Body parameters
Nome, Tipo, Descrição
`sha`stringObrigatório The SHA1 value to set this reference to
`force`boolean Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work. Padrão: `false`

HTTP response status codes

Status code	Descrição
`200`	OK
`422`	Validation failed

Amostras de código

patch/repos/{owner}/{repo}/git/refs/{ref}

curl \
  -X PATCH \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/refs/REF \
  -d '{"sha":"aa218f56b14c9653891f9e74264a383fa43fefbd","force":true}'

Response

Status: 200

{
  "ref": "refs/heads/featureA",
  "node_id": "MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==",
  "url": "https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA",
  "object": {
    "type": "commit",
    "sha": "aa218f56b14c9653891f9e74264a383fa43fefbd",
    "url": "https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd"
  }
}

Delete a reference

Works with GitHub Apps

Parâmetros

Headers
Nome, Tipo, Descrição
`accept`string Setting to `application/vnd.github.v3+json` is recommended.
Path parameters
Nome, Tipo, Descrição
`owner`stringObrigatório The account owner of the repository. The name is not case sensitive.
`repo`stringObrigatório The name of the repository. The name is not case sensitive.
`ref`stringObrigatório ref parameter

HTTP response status codes

Status code	Descrição
`204`	No Content
`422`	Validation failed

Amostras de código

delete/repos/{owner}/{repo}/git/refs/{ref}

curl \
  -X DELETE \
  -H "Accept: application/vnd.github.v3+json" \ 
  -H "Authorization: token <TOKEN>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/git/refs/REF

Response

Status: 204