Vínculos automáticos del repositorio
Usa la API REST para agregar vínculos automáticos a recursos externos.
Acerca de los vínculos automáticos del repositorio
Para ayudar a optimizar tu flujo de trabajo, puedes utilizar la API REST para agregar vínculos automáticos a recursos externos como incidencias de JIRA y vales de Zendesk. Para obtener más información, vea «Configurar enlaces automáticos para referenciar recursos externos».
Las GitHub Apps requieren permisos de administración de repositorios con acceso de lectura o escritura para utilizar estos puntos de conexión.
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"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros de la ruta de acceso |
Nombre, Tipo, Descripción |
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository. The name is not case sensitive. |
Parámetros de consulta |
Nombre, Tipo, Descripción |
page integer Page number of the results to fetch. Valor predeterminado: |
Códigos de estado de respuesta HTTP para "List all autolinks of a repository"
status code | Descripción |
---|---|
200 | OK |
Ejemplos de código para "List all autolinks of a repository"
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
}
]
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"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros de la ruta de acceso |
Nombre, Tipo, Descripción |
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository. The name is not case sensitive. |
Parámetros del cuerpo |
Nombre, Tipo, Descripción |
key_prefix string RequeridoThis prefix appended by certain characters will generate a link any time it is found in an issue, pull request, or commit. |
url_template string RequeridoThe URL must contain |
is_alphanumeric boolean Whether this autolink reference matches alphanumeric characters. If true, the Valor predeterminado: |
Códigos de estado de respuesta HTTP para "Create an autolink reference for a repository"
status code | Descripción |
---|---|
201 | Created |
422 | Validation failed, or the endpoint has been spammed. |
Ejemplos 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>"\
-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
}
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"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros de la ruta de acceso |
Nombre, Tipo, Descripción |
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository. The name is not case sensitive. |
autolink_id integer RequeridoThe unique identifier of the autolink. |
Códigos de estado de respuesta HTTP para "Get an autolink reference of a repository"
status code | Descripción |
---|---|
200 | OK |
404 | Resource not found |
Ejemplos de código para "Get an autolink reference of a repository"
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
}
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"
Encabezados |
---|
Nombre, Tipo, Descripción |
accept string Setting to |
Parámetros de la ruta de acceso |
Nombre, Tipo, Descripción |
owner string RequeridoThe account owner of the repository. The name is not case sensitive. |
repo string RequeridoThe name of the repository. The name is not case sensitive. |
autolink_id integer RequeridoThe unique identifier of the autolink. |
Códigos de estado de respuesta HTTP para "Delete an autolink reference from a repository"
status code | Descripción |
---|---|
204 | No Content |
404 | Resource not found |
Ejemplos 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>"\
-H "X-GitHub-Api-Version: 2022-11-28" \
https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID
Response
Status: 204