이제 REST API의 버전이 지정되었습니다. 자세한 내용은 "API 버전 관리 정보"를 참조하세요.

리포지토리 자동 링크에 대한 REST API 엔드포인트

REST API를 사용하여 외부 리소스에 자동 링크를 추가합니다.

워크플로를 간소화하기 위해 REST API를 사용하여 JIRA 이슈, Zendesk 티켓 등의 외부 리소스에 대한 자동 링크를 추가할 수 있습니다. 자세한 내용은 "외부 리소스를 참조하도록 자동 링크 구성"을(를) 참조하세요.

GitHub Apps에서 이러한 엔드포인트를 사용하려면 읽기 또는 쓰기 권한이 있는 리포지토리 관리 권한이 필요합니다.

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"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

"Get all autolinks of a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
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" \ 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 } ]

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"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

본문 매개 변수
key_prefix string Required

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 Required

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

"Create an autolink reference for a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
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" \ 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 }

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"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

autolink_id integer Required

The unique identifier of the autolink.

"Get an autolink reference of a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
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" \ 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 }

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"에 대한 매개 변수

머리글
accept string

Setting to application/vnd.github+json is recommended.

경로 매개 변수
owner string Required

The account owner of the repository. The name is not case sensitive.

repo string Required

The name of the repository without the .git extension. The name is not case sensitive.

autolink_id integer Required

The unique identifier of the autolink.

"Delete an autolink reference from a repository"에 대한 HTTP 응답 상태 코드

상태 코드설명
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" \ https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204