Конечные точки REST API для автоматических ссылок репозитория

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

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

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

Get all autolinks of a repository

Gets all autolinks that are configured for a repository.

Information about autolinks are only available to repository administrators.

Подробные маркеры доступа для "Get all autolinks of a repository

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Administration" repository permissions (read)

Параметры для "Get all autolinks of a repository"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Коды состояния http-ответа для "Get all autolinks of a repository"

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

Примеры кода для "Get all autolinks of a repository"

Пример запроса

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/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

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Administration" repository permissions (write)

Параметры для "Create an autolink reference for a repository"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.

Параметры запроса
Имя., Тип, 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 `<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-ответа для "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"

Пример запроса

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

curl -L \
  -X POST \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  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.

Подробные маркеры доступа для "Get an autolink reference of a repository

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Administration" repository permissions (read)

Параметры для "Get an autolink reference of a repository"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.
`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"

Пример запроса

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

curl -L \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://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>",
  "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

Эта конечная точка работает со следующими точными типами маркеров:

Маркер с точной детализацией должен иметь следующий набор разрешений.:

"Administration" repository permissions (write)

Параметры для "Delete an autolink reference from a repository"

Заголовки
Имя., Тип, Description
`accept` string Setting to `application/vnd.github+json` is recommended.

Параметры пути
Имя., Тип, Description
`owner` string Обязательное поле The account owner of the repository. The name is not case sensitive.
`repo` string Обязательное поле The name of the repository without the `.git` extension. The name is not case sensitive.
`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"

Пример запроса

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

curl -L \
  -X DELETE \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204