Skip to main content
O controle de versão da API REST já foi feito. Para obter mais informações, confira "Sobre o controle de versão da API".

Links automáticos do repositório

Use a API REST para adicionar links automáticos a recursos externos.

Para ajudar a agilizar o fluxo de trabalho, é possível usar a API REST a fim de adicionar os links automáticos a recursos externos, como problemas do JIRA e tíquetes do Zendesk. Para obter mais informações, confira "Configurar links automáticos para fazer referência a recursos externos".

Os GitHub Apps exigem permissões de administração do repositório com acesso de leitura ou gravação para usar esses pontos de extremidade.

Gets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators.

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter os seguintes conjuntos de permissões:

  • administration:read
Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

The account owner of the repository. The name is not case sensitive.

repo string Obrigatório

The name of the repository without the .git extension. The name is not case sensitive.

Código de statusDescrição
200

OK

Exemplo de solicitação

get/repos/{owner}/{repo}/autolinks
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks

Response

Status: 200
[ { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true } ]

Users with admin access to the repository can create an autolink.

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter os seguintes conjuntos de permissões:

  • administration:write
Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

The account owner of the repository. The name is not case sensitive.

repo string Obrigatório

The name of the repository without the .git extension. The name is not case sensitive.

Parâmetros do corpo
Nome, Tipo, Descrição
key_prefix string Obrigatório

This prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit.

url_template string Obrigatório

The URL must contain <num> for the reference number. <num> matches different characters depending on the value of is_alphanumeric.

is_alphanumeric boolean

Whether this autolink reference matches alphanumeric characters. If true, the <num> parameter of the url_template matches alphanumeric characters A-Z (case insensitive), 0-9, and -. If false, this autolink reference only matches numeric characters.

Padrão: true

Código de statusDescrição
201

Created

422

Validation failed, or the endpoint has been spammed.

Exemplo de solicitação

post/repos/{owner}/{repo}/autolinks
curl -L \ -X POST \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks \ -d '{"key_prefix":"TICKET-","url_template":"https://example.com/TICKET?query=<num>","is_alphanumeric":true}'

response

Status: 201
{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }

This returns a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter os seguintes conjuntos de permissões:

  • administration:read
Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

The account owner of the repository. The name is not case sensitive.

repo string Obrigatório

The name of the repository without the .git extension. The name is not case sensitive.

autolink_id integer Obrigatório

The unique identifier of the autolink.

Código de statusDescrição
200

OK

404

Resource not found

Exemplo de solicitação

get/repos/{owner}/{repo}/autolinks/{autolink_id}
curl -L \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 200
{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }

This deletes a single autolink reference by ID that was configured for the given repository.

Information about autolinks are only available to repository administrators.

Esse ponto de extremidade funciona com os seguintes tipos de token:

O token deve ter os seguintes conjuntos de permissões:

  • administration:write
Cabeçalhos
Nome, Tipo, Descrição
accept string

Setting to application/vnd.github+json is recommended.

Parâmetros de caminho
Nome, Tipo, Descrição
owner string Obrigatório

The account owner of the repository. The name is not case sensitive.

repo string Obrigatório

The name of the repository without the .git extension. The name is not case sensitive.

autolink_id integer Obrigatório

The unique identifier of the autolink.

Código de statusDescrição
204

No Content

404

Resource not found

Exemplo de solicitação

delete/repos/{owner}/{repo}/autolinks/{autolink_id}
curl -L \ -X DELETE \ -H "Accept: application/vnd.github+json" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "X-GitHub-Api-Version: 2022-11-28" \ https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204