存储库自动链接
使用 REST API 向外部资源添加自动链接。
关于存储库自动链接
为了帮助简化工作流,你可以使用 REST API 向外部资源(如 JIRA 问题和 Zendesk 事件单)添加自动链接。 有关详细信息,请参阅“配置自动链接以引用外部资源”。
GitHub Apps 需要有读写权限的存储库管理权限才能使用这些终结点。
List all autolinks of a repository
This returns a list of autolinks configured for the given repository.
Information about autolinks are only available to repository administrators.
Parameters for "List all autolinks of a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
名称, 类型, 说明 |
---|
page integer Page number of the results to fetch. 默认: |
HTTP response status codes for "List all autolinks of a repository"
Status code | Description |
---|---|
200 | OK |
Code samples for "List all autolinks of a repository"
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
}
]
Create an autolink reference for a repository
Users with admin access to the repository can create an autolink.
Parameters for "Create an autolink reference for a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
名称, 类型, 说明 |
---|
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 |
is_alphanumeric boolean Whether this autolink reference matches alphanumeric characters. If true, the 默认: |
HTTP response status codes for "Create an autolink reference for a repository"
Status code | Description |
---|---|
201 | Created |
422 | Validation failed, or the endpoint has been spammed. |
Code samples for "Create an autolink reference for a repository"
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
}
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.
Parameters for "Get an autolink reference of a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
autolink_id integer 必须The unique identifier of the autolink. |
HTTP response status codes for "Get an autolink reference of a repository"
Status code | Description |
---|---|
200 | OK |
404 | Resource not found |
Code samples for "Get an autolink reference of a repository"
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
}
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.
Parameters for "Delete an autolink reference from a repository"
名称, 类型, 说明 |
---|
accept string Setting to |
名称, 类型, 说明 |
---|
owner string 必须The account owner of the repository. The name is not case sensitive. |
repo string 必须The name of the repository without the |
autolink_id integer 必须The unique identifier of the autolink. |
HTTP response status codes for "Delete an autolink reference from a repository"
Status code | Description |
---|---|
204 | No Content |
404 | Resource not found |
Code samples for "Delete an autolink reference from a repository"
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