适用于议题类型的 REST API 终结点

List issue types for an organization

Lists all issue types for an organization.

“List issue types for an organization”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

"Issue Types" organization permissions (read)

“List issue types for an organization”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.

“List issue types for an organization”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found

“List issue types for an organization”的示例代码

请求示例

get/orgs/{org}/issue-types

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/orgs/ORG/issue-types

Response

Status: 200

[
  {
    "id": 410,
    "node_id": "IT_kwDNAd3NAZo",
    "name": "Task",
    "description": "A specific piece of work",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  },
  {
    "id": 411,
    "node_id": "IT_kwDNAd3NAZs",
    "name": "Bug",
    "description": "An unexpected problem or behavior",
    "created_at": "2024-12-11T14:39:09Z",
    "updated_at": "2024-12-11T14:39:09Z"
  }
]

Create issue type for an organization

Create a new issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

“Create issue type for an organization”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

"Issue Types" organization permissions (write)

“Create issue type for an organization”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.

正文参数
名称, 类型, 说明
`name` string 必须 Name of the issue type.
`is_enabled` boolean 必须 Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. 可以是以下选项之一: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

“Create issue type for an organization”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Create issue type for an organization”的示例代码

请求示例

post/orgs/{org}/issue-types

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/orgs/ORG/issue-types \
  -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200

{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

Update issue type for an organization

Updates an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

“Update issue type for an organization”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

"Issue Types" organization permissions (write)

“Update issue type for an organization”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`issue_type_id` integer 必须 The unique identifier of the issue type.

正文参数
名称, 类型, 说明
`name` string 必须 Name of the issue type.
`is_enabled` boolean 必须 Whether or not the issue type is enabled at the organization level.
`is_private` boolean Whether or not the issue type is restricted to issues in private repositories.
`description` string or null Description of the issue type.
`color` string or null Color for the issue type. 可以是以下选项之一: `gray`, `blue`, `green`, `yellow`, `orange`, `red`, `pink`, `purple`, `null`

“Update issue type for an organization”的 HTTP 响应状态代码

状态代码	说明
`200`	OK
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Update issue type for an organization”的示例代码

请求示例

put/orgs/{org}/issue-types/{issue_type_id}

curl -L \
  -X PUT \
  -H "Accept: application/vnd.github+json" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "X-GitHub-Api-Version: 2022-11-28" \
  https://api.github.com/orgs/ORG/issue-types/ISSUE_TYPE_ID \
  -d '{"name":"Epic","description":"An issue type for a multi-week tracking of work","is_enabled":true,"color":"green"}'

Response

Status: 200

{
  "id": 410,
  "node_id": "IT_kwDNAd3NAZo",
  "name": "Task",
  "description": "A specific piece of work",
  "created_at": "2024-12-11T14:39:09Z",
  "updated_at": "2024-12-11T14:39:09Z"
}

Delete issue type for an organization

Deletes an issue type for an organization.

You can find out more about issue types in Managing issue types in an organization.

“Delete issue type for an organization”的细粒度访问令牌

此端点支持以下精细令牌类型:

精细令牌必须具有以下权限集:

"Issue Types" organization permissions (write)

“Delete issue type for an organization”的参数

标头
名称, 类型, 说明
`accept` string Setting to `application/vnd.github+json` is recommended.

路径参数
名称, 类型, 说明
`org` string 必须 The organization name. The name is not case sensitive.
`issue_type_id` integer 必须 The unique identifier of the issue type.

“Delete issue type for an organization”的 HTTP 响应状态代码

状态代码	说明
`204`	No Content
`404`	Resource not found
`422`	Validation failed, or the endpoint has been spammed.

“Delete issue type for an organization”的示例代码

请求示例

delete/orgs/{org}/issue-types/{issue_type_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/orgs/ORG/issue-types/ISSUE_TYPE_ID

Response

Status: 204