Автоматические ссылки репозитория
Используйте REST API для добавления автоматических ссылок на внешние ресурсы.
Сведения об автоматическом связывании репозитория
Чтобы упростить рабочий процесс, можно использовать REST API для добавления автоматических ссылок на внешние ресурсы, такие как проблемы JIRA и Zendesk. Дополнительные сведения см. в разделе «AUTOTITLE».
GitHub Apps требуют разрешения администрирования репозитория с доступом на чтение или запись для использования этих конечных точек.
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.
Параметры для "List all autolinks of a repository"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя., Тип, Description |
---|
page integer Page number of the results to fetch. По умолчанию.: |
Коды состояния http-ответа для "List all autolinks of a repository"
Код состояния | Описание |
---|---|
200 | OK |
Примеры кода для "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.
Параметры для "Create an autolink reference for a repository"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
Имя., Тип, Description |
---|
key_prefix string Обязательное поле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 Обязательное полеThe URL must contain |
is_alphanumeric boolean Whether this autolink reference matches alphanumeric characters. If true, the По умолчанию.: |
Коды состояния http-ответа для "Create an autolink reference for a repository"
Код состояния | Описание |
---|---|
201 | Created |
422 | Validation failed, or the endpoint has been spammed. |
Примеры кода для "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.
Параметры для "Get an autolink reference of a repository"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
autolink_id integer Обязательное полеThe unique identifier of the autolink. |
Коды состояния http-ответа для "Get an autolink reference of a repository"
Код состояния | Описание |
---|---|
200 | OK |
404 | Resource not found |
Примеры кода для "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.
Параметры для "Delete an autolink reference from a repository"
Имя., Тип, Description |
---|
accept string Setting to |
Имя., Тип, Description |
---|
owner string Обязательное полеThe account owner of the repository. The name is not case sensitive. |
repo string Обязательное полеThe name of the repository without the |
autolink_id integer Обязательное полеThe unique identifier of the autolink. |
Коды состояния http-ответа для "Delete an autolink reference from a repository"
Код состояния | Описание |
---|---|
204 | No Content |
404 | Resource not found |
Примеры кода для "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