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