存储库自动链接

为了帮助简化您的工作流程，您可以使用 API 向外部资源（如 JIRA 问题和 Zendesk 事件单）添加自动链接。

关于存储库自动链接 API

更多信息请参阅“配置自动链接以引用外部资源”。

GitHub 应用程序需要有读写权限的仓库管理权限才能使用 Autolinks API。

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: token <TOKEN>" \
  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必选 The prefix appended by alphanumeric 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 alphanumeric characters `A-Z` (case insensitive), `0-9`, and `-`.

HTTP 响应状态代码

状态代码	描述
`201`	Created
`422`	Validation failed

代码示例

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

curl \
  -X POST \
  -H "Accept: application/vnd.github+json" \ 
  -H "Authorization: token <TOKEN>" \
  https://api.github.com/repos/OWNER/REPO/autolinks \
  -d '{"key_prefix":"TICKET-","url_template":"https://example.com/TICKET?query=<num>"}'

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: token <TOKEN>" \
  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: token <TOKEN>" \
  https://api.github.com/repos/OWNER/REPO/autolinks/AUTOLINK_ID

Response

Status: 204