仓库自动链接的 REST API 端点
使用 REST API 将自动链接添加到外部资源。
关于仓库自动链接
为了帮助简化您的工作流程，您可以使用 REST API 将自动链接添加到外部资源（如 JIRA 问题和 Zendesk 工单）。有关更多信息，请参阅“配置自动链接以引用外部资源”。
GitHub Apps 需要具有读取或写入访问权限的仓库管理权限才能使用这些端点。
获取仓库的所有自动链接
获取为仓库配置的所有自动链接。
有关自动链接的信息仅对仓库管理员可用。
“获取仓库的所有自动链接”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”仓库权限（读取）
“获取仓库的所有自动链接”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
owner 字符串 必填仓库的账户所有者。名称不区分大小写。 |
repo 字符串 必填仓库的名称，不含 |
“获取仓库的所有自动链接”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
“获取仓库的所有自动链接”的代码示例
请求示例
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响应
状态：200[ { "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true } ]为仓库创建自动链接引用
具有仓库管理员访问权限的用户可以创建自动链接。
“为仓库创建自动链接引用”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”仓库权限（写入）
“为仓库创建自动链接引用”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
owner 字符串 必填仓库的账户所有者。名称不区分大小写。 |
repo 字符串 必填仓库的名称，不含 |
| 名称、类型、描述 |
|---|
key_prefix 字符串 必填此前缀后跟某些字符，将在问题、拉取请求或提交中找到时生成链接。 |
url_template 字符串 必填URL 必须包含 |
is_alphanumeric 布尔值此自动链接引用是否匹配字母数字字符。如果为 true，则 默认： |
“为仓库创建自动链接引用”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
201 | 已创建 |
422 | 验证失败，或端点已被垃圾邮件轰炸。 |
“为仓库创建自动链接引用”的代码示例
请求示例
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}'响应
状态：201{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }获取仓库的自动链接引用
这将返回为给定仓库配置的单个自动链接引用（按 ID）。
有关自动链接的信息仅对仓库管理员可用。
“获取仓库的自动链接引用”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”仓库权限（读取）
“获取仓库的自动链接引用”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
owner 字符串 必填仓库的账户所有者。名称不区分大小写。 |
repo 字符串 必填仓库的名称，不含 |
autolink_id 整数 必填自动链接的唯一标识符。 |
“获取仓库的自动链接引用”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
200 | OK |
404 | 资源未找到 |
“获取仓库的自动链接引用”的代码示例
请求示例
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响应
状态：200{ "id": 1, "key_prefix": "TICKET-", "url_template": "https://example.com/TICKET?query=<num>", "is_alphanumeric": true }从仓库删除自动链接引用
这将删除为给定仓库配置的单个自动链接引用（按 ID）。
有关自动链接的信息仅对仓库管理员可用。
“从仓库删除自动链接引用”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “管理”仓库权限（写入）
“从仓库删除自动链接引用”的参数
| 名称、类型、描述 |
|---|
accept 字符串建议设置为 |
| 名称、类型、描述 |
|---|
owner 字符串 必填仓库的账户所有者。名称不区分大小写。 |
repo 字符串 必填仓库的名称，不含 |
autolink_id 整数 必填自动链接的唯一标识符。 |
“从仓库删除自动链接引用”的 HTTP 响应状态代码
| 状态代码 | 描述 |
|---|---|
204 | 无内容 |
404 | 资源未找到 |
“从仓库删除自动链接引用”的代码示例
请求示例
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响应
状态：204