Автоматические ссылки репозитория

Используйте REST API для добавления автоматических ссылок на внешние ресурсы.

Сведения об автоматических ссылках на репозиторий

Чтобы упростить рабочий процесс, можно использовать REST API для добавления автоматических ссылок на внешние ресурсы, такие как проблемы JIRA и билеты Zendesk. Дополнительные сведения см. в статье "Настройка автоматических ссылок для ссылок на внешние ресурсы".

GitHub Apps требуются разрешения администрирования репозитория с доступом на чтение или запись для использования этих конечных точек.

List all autolinks of a repository

Работа с GitHub Apps

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

Information about autolinks are only available to repository administrators.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`page`integer Page number of the results to fetch. Значение по умолчанию: `1`

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK

Примеры кода

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

curl \
  -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

Работа с GitHub Apps

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

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
Параметры запроса
Имя, Тип, Описание
`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 `<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. Значение по умолчанию: `true`

Коды состояния HTTP-ответа

Код состояния	Описание
`201`	Created
`422`	Validation failed, or the endpoint has been spammed.

Примеры кода

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

curl \
  -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

Работа с 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.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`autolink_id`integerОбязательно The unique identifier of the autolink.

Коды состояния HTTP-ответа

Код состояния	Описание
`200`	OK
`404`	Resource not found

Примеры кода

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

curl \
  -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

Работа с 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.

Параметры

Заголовки
Имя, Тип, Описание
`accept`string Setting to `application/vnd.github+json` is recommended.
Параметры пути
Имя, Тип, Описание
`owner`stringОбязательно The account owner of the repository. The name is not case sensitive.
`repo`stringОбязательно The name of the repository. The name is not case sensitive.
`autolink_id`integerОбязательно The unique identifier of the autolink.

Коды состояния HTTP-ответа

Код состояния	Описание
`204`	No Content
`404`	Resource not found

Примеры кода

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

curl \
  -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

Jan	FEB	Mar
	03
2022	2023	2024