리포지토리 자동 링크

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

About repository autolinks

To help streamline your workflow, you can use the REST API to add autolinks to external resources like JIRA issues and Zendesk tickets. For more information, see "Configuring autolinks to reference external resources."

GitHub Apps require repository administration permissions with read or write access to use these endpoints.

List all autolinks of a repository

Works with GitHub Apps

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

머리글
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`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.

쿼리 매개 변수
이름, Type, 설명
`page` integer Page number of the results to fetch. 기본값: `1`

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

상태 코드	설명
`200`	OK

"List all autolinks of a repository"에 대한 코드 샘플

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

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

Works with GitHub Apps

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

"Create an autolink reference for a repository"에 대한 매개 변수

머리글
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`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.

본문 매개 변수
이름, Type, 설명
`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>" \
  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

Works with 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.

"Get an autolink reference of a repository"에 대한 매개 변수

머리글
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`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>" \
  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

Works with 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.

"Delete an autolink reference from a repository"에 대한 매개 변수

머리글
이름, Type, 설명
`accept` string Setting to `application/vnd.github+json` is recommended.

경로 매개 변수
이름, Type, 설명
`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>" \
  http(s)://HOSTNAME/api/v3/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204