REST API 现在已版本化。 有关更多信息,请参阅“关于 API 版本控制”。
自定义属性的 REST API 端点
使用 REST API 列出组织为仓库分配的自定义属性。
关于自定义属性
您可以使用 REST API 查看由拥有仓库的组织分配给仓库的自定义属性。有关更多信息,请参阅“管理组织中仓库的自定义属性”。有关管理自定义属性的 REST API 端点的更多信息,请参阅“自定义属性的 REST API 端点”。
获取仓库的所有自定义属性值
获取为仓库设置的所有自定义属性值。具有仓库读取访问权限的用户可以使用此端点。
“获取仓库的所有自定义属性值”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “元数据”仓库权限(读取)
如果仅请求公共资源,则可以在没有身份验证或上述权限的情况下使用此端点。
“获取仓库的所有自定义属性值”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
owner 字符串 必需仓库的帐户所有者。名称不区分大小写。 |
repo 字符串 必需不带 |
“获取仓库的所有自定义属性值”的 HTTP 响应状态代码
状态代码 | 描述 |
---|---|
200 | 确定 |
403 | 禁止 |
404 | 资源未找到 |
“获取仓库的所有自定义属性值”的代码示例
请求示例
获取/repos/{owner}/{repo}/properties/values
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/properties/values
回应
创建或更新仓库的自定义属性值
创建新的或更新现有的仓库自定义属性值。为自定义属性使用 null
值将删除或“取消设置”仓库中的属性值。
仓库管理员和其他具有仓库级“编辑自定义属性值”细粒度权限的用户可以使用此端点。
“创建或更新仓库的自定义属性值”的细粒度访问令牌
此端点适用于以下细粒度令牌类型:
细粒度令牌必须具有以下权限集
- “自定义属性”仓库权限(写入)
“创建或更新仓库的自定义属性值”的参数
名称,类型,描述 |
---|
accept 字符串建议设置为 |
名称,类型,描述 |
---|
owner 字符串 必需仓库的帐户所有者。名称不区分大小写。 |
repo 字符串 必需不带 |
名称,类型,描述 | |||
---|---|---|---|
properties 对象数组 必需要应用于仓库的自定义属性名称和关联值的列表。 | |||
|
名称,类型,描述 |
---|
property_name 字符串 必需属性的名称 |
value null 或字符串或数组 必需分配给属性的值 |
“创建或更新仓库的自定义属性值”的 HTTP 响应状态代码
状态代码 | 描述 |
---|---|
204 | 成功创建或更新自定义属性值时,无内容。 |
403 | 禁止 |
404 | 资源未找到 |
422 | 验证失败,或端点已被滥用。 |
“创建或更新仓库的自定义属性值”的代码示例
请求示例
修补/repos/{owner}/{repo}/properties/values
curl -L \ -X PATCH \ -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/properties/values \ -d '{"properties":[{"property_name":"environment","value":"production"},{"property_name":"service","value":"web"},{"property_name":"team","value":"octocat"}]}'
成功创建或更新自定义属性值时,无内容。
状态:204