Recentemente, movemos algumas das documentações da API REST. Se você não conseguir encontrar o que está procurando, tente as novas páginas da API REST Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks}.
Links automáticos do repositório
Use a API REST para adicionar links automáticos a recursos externos.
Sobre os links automáticos de repositório
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.
List all autolinks of a repository
This returns a list of autolinks configured for the given repository.
Information about autolinks are only available to repository administrators.
Parâmetros para "List all autolinks of a repository"
| Cabeçalhos |
|---|
| Nome, Tipo, Descrição |
accept string Setting to |
| Parâmetros de caminho |
| Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
| Parâmetros de consulta |
| Nome, Tipo, Descrição |
page integer Page number of the results to fetch. Padrão: |
Códigos de status de resposta HTTP para "List all autolinks of a repository"
| Código de status | Descrição |
|---|---|
200 | OK |
Exemplos de código para "List all autolinks of a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/autolinksResponse
Status: 200[
{
"id": 1,
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}
]Create an autolink reference for a repository
Users with admin access to the repository can create an autolink.
Parâmetros para "Create an autolink reference for a repository"
| Cabeçalhos |
|---|
| Nome, Tipo, Descrição |
accept string Setting to |
| Parâmetros de caminho |
| Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
| Parâmetros do corpo |
| Nome, Tipo, Descrição |
key_prefix string ObrigatórioThis 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órioThe URL must contain |
is_alphanumeric boolean Whether this autolink reference matches alphanumeric characters. If true, the Padrão: |
Códigos de status de resposta HTTP para "Create an autolink reference for a repository"
| Código de status | Descrição |
|---|---|
201 | Created |
422 | Validation failed, or the endpoint has been spammed. |
Exemplos de código para "Create an autolink reference for a repository"
curl -L \
-X POST \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/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
}Get an autolink reference of a repository
This returns a single autolink reference by ID that was configured for the given repository.
Information about autolinks are only available to repository administrators.
Parâmetros para "Get an autolink reference of a repository"
| Cabeçalhos |
|---|
| Nome, Tipo, Descrição |
accept string Setting to |
| Parâmetros de caminho |
| Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
autolink_id integer ObrigatórioThe unique identifier of the autolink. |
Códigos de status de resposta HTTP para "Get an autolink reference of a repository"
| Código de status | Descrição |
|---|---|
200 | OK |
404 | Resource not found |
Exemplos de código para "Get an autolink reference of a repository"
curl -L \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_IDResponse
Status: 200{
"id": 1,
"key_prefix": "TICKET-",
"url_template": "https://example.com/TICKET?query=<num>",
"is_alphanumeric": true
}Delete an autolink reference from a repository
This deletes a single autolink reference by ID that was configured for the given repository.
Information about autolinks are only available to repository administrators.
Parâmetros para "Delete an autolink reference from a repository"
| Cabeçalhos |
|---|
| Nome, Tipo, Descrição |
accept string Setting to |
| Parâmetros de caminho |
| Nome, Tipo, Descrição |
owner string ObrigatórioThe account owner of the repository. The name is not case sensitive. |
repo string ObrigatórioThe name of the repository. The name is not case sensitive. |
autolink_id integer ObrigatórioThe unique identifier of the autolink. |
Códigos de status de resposta HTTP para "Delete an autolink reference from a repository"
| Código de status | Descrição |
|---|---|
204 | No Content |
404 | Resource not found |
Exemplos de código para "Delete an autolink reference from a repository"
curl -L \
-X DELETE \
-H "Accept: application/vnd.github+json" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_IDResponse
Status: 204