Liens automatiques du référentiel

Utilisez l’API REST pour ajouter des liens automatiques à des ressources externes.

À propos des liens automatiques du référentiel

Pour simplifier votre workflow, vous pouvez utiliser l’API REST afin d’ajouter des liens automatiques à des ressources externes comme des problèmes JIRA et des tickets Zendesk. Pour plus d’informations, consultez « Configuration de liens automatiques pour référencer des ressources externes ».

Les GitHub Apps nécessitent des autorisations d’administration de référentiel avec un accès en lecture ou en écriture pour utiliser ces points de terminaison.

List all autolinks of a repository

Compatible avec GitHub Apps

This returns a list of autolinks configured for the given repository.

Information about autolinks are only available to repository administrators.

Paramètres pour « List all autolinks of a repository »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`owner` string Obligatoire The account owner of the repository. The name is not case sensitive.
`repo` string Obligatoire The name of the repository without the `.git` extension. The name is not case sensitive.

Paramètres de requête
Nom, Type, Description
`page` integer Page number of the results to fetch. Default: `1`

Codes d’état de la réponse HTTP pour « List all autolinks of a repository »

Code d’état	Description
`200`	OK

Exemples de code pour « List all autolinks of a repository »

get/repos/{owner}/{repo}/autolinks

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks

Response

Status: 200

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

Create an autolink reference for a repository

Compatible avec GitHub Apps

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

Paramètres pour « Create an autolink reference for a repository »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`owner` string Obligatoire The account owner of the repository. The name is not case sensitive.
`repo` string Obligatoire The name of the repository without the `.git` extension. The name is not case sensitive.

Paramètres du corps
Nom, Type, Description
`key_prefix` string Obligatoire The prefix appended by a number will generate a link any time it is found in an issue, pull request, or commit.
`url_template` string Obligatoire The URL must contain `<num>` for the reference number.
`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. Default: `true`

Codes d’état de la réponse HTTP pour « Create an autolink reference for a repository »

Code d’état	Description
`201`	Created
`422`	Validation failed, or the endpoint has been spammed.

Exemples de code pour « Create an autolink reference for a repository »

post/repos/{owner}/{repo}/autolinks

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://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>"
}

Get an autolink reference of a repository

Compatible avec GitHub Apps

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

Information about autolinks are only available to repository administrators.

Paramètres pour « Get an autolink reference of a repository »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`owner` string Obligatoire The account owner of the repository. The name is not case sensitive.
`repo` string Obligatoire The name of the repository without the `.git` extension. The name is not case sensitive.
`autolink_id` integer Obligatoire The unique identifier of the autolink.

Codes d’état de la réponse HTTP pour « Get an autolink reference of a repository »

Code d’état	Description
`200`	OK
`404`	Resource not found

Exemples de code pour « Get an autolink reference of a repository »

get/repos/{owner}/{repo}/autolinks/{autolink_id}

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 200

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

Delete an autolink reference from a repository

Compatible avec GitHub Apps

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

Information about autolinks are only available to repository administrators.

Paramètres pour « Delete an autolink reference from a repository »

En-têtes
Nom, Type, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Paramètres de chemin d’accès
Nom, Type, Description
`owner` string Obligatoire The account owner of the repository. The name is not case sensitive.
`repo` string Obligatoire The name of the repository without the `.git` extension. The name is not case sensitive.
`autolink_id` integer Obligatoire The unique identifier of the autolink.

Codes d’état de la réponse HTTP pour « Delete an autolink reference from a repository »

Code d’état	Description
`204`	No Content
`404`	Resource not found

Exemples de code pour « Delete an autolink reference from a repository »

delete/repos/{owner}/{repo}/autolinks/{autolink_id}

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  https://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204