🛎️ CNB OpenAPI 更新追踪#1
01624376| 项目 | 信息 |
|---|---|
| 新增接口 | 1 个 |
| 修改接口 | 0 个 |
| 删除接口 | 1 个 |
| ⚠️ 破坏性变更 | 有(1 处) |
本次版本共涉及 2 个接口变更,其中 1 处破坏性变更,请重点关注。
以下变更可能导致现有客户端不兼容,请优先关注。
GET /npc/search:接口已删除| 分类 | 方法 | 路径 | 描述 |
|---|---|---|---|
| knowledgebase | GET | /npc/search | 全局语义搜索 NPC 角色 |
| 分类 | 方法 | 路径 | 描述 |
|---|---|---|---|
| knowledgebase | GET | /search/npc | 全局语义搜索 NPC 角色 |
85582c18| 项目 | 信息 |
|---|---|
| 新增接口 | 3 个 |
| 修改接口 | 19 个 |
| 删除接口 | 0 个 |
| ⚠️ 破坏性变更 | 有(4 处) |
本次版本共涉及 22 个接口变更,其中 4 处破坏性变更,请重点关注。
以下变更可能导致现有客户端不兼容,请优先关注。
GET /ranks/repo/annual:响应类型变更: dto.RankDetailWithIncr → dto.GetRankResultGET /ranks/repo/annual:响应数组类型变更: true → falseGET /ranks/repo/daily:响应类型变更: dto.RankDetailWithIncr → dto.GetRankResultGET /ranks/repo/daily:响应数组类型变更: true → falseGET /ranks/repo/monthly:响应类型变更: dto.RankDetailWithIncr → dto.GetRankResultGET /ranks/repo/monthly:响应数组类型变更: true → falseGET /ranks/repo/weekly:响应类型变更: dto.RankDetailWithIncr → dto.GetRankResultGET /ranks/repo/weekly:响应数组类型变更: true → false| 分类 | 方法 | 路径 | 描述 |
|---|---|---|---|
| issues | GET | /{repo}/-/issues/{number}/property | 查询指定Issue的自定义属性列表。Get issue custom properties. |
| issues | GET | /{repo}/-/property | 查询仓库可见的自定义属性列表。List repository visible custom properties. |
| issues | GET | /{repo}/-/property/invisible | 查询仓库不可见的自定义属性列表。List repository invisible custom properties. |
| 分类 | 方法 | 路径 | 变更类型 |
|---|---|---|---|
| activities | GET | /{repo}/-/top-activity-users | 模型字段变更 |
| gitsettings | GET | /{repo}/-/settings/cloud-native-build | 模型字段变更 |
| gitsettings | PUT | /{repo}/-/settings/cloud-native-build | 模型字段变更 |
| issues | POST | /{repo}/-/issues | 模型字段变更 |
| issues | GET | /{repo}/-/issues/{number} | 模型字段变更 |
| issues | PATCH | /{repo}/-/issues/{number} | 模型字段变更 |
| issues | DELETE | /{repo}/-/issues/{number}/assignees | 模型字段变更 |
| issues | PATCH | /{repo}/-/issues/{number}/assignees | 模型字段变更 |
| issues | POST | /{repo}/-/issues/{number}/assignees | 模型字段变更 |
| issues | POST | /{repo}/-/issues/{number}/comment-file-asset-upload-url | 操作ID变更, 模型字段变更 |
| issues | POST | /{repo}/-/issues/{number}/comment-image-asset-upload-url | 操作ID变更, 模型字段变更 |
| knowledgebase | GET | /search/npc | 模型字段变更 |
| members | GET | /{slug}/-/outside-collaborators | 模型字段变更 |
| rank | GET | /ranks/repo/annual | 响应变更, 其他 |
| rank | GET | /ranks/repo/daily | 响应变更, 其他 |
| rank | GET | /ranks/repo/monthly | 其他, 响应变更 |
| rank | GET | /ranks/repo/weekly | 响应变更, 其他 |
| users | GET | /user | 模型字段变更 |
| users | GET | /users/{username} | 模型字段变更 |
详细说明:
GET /{repo}/-/top-activity-users:
UsersResult 新增字段 identity_providers ([]string)GET /{repo}/-/settings/cloud-native-build:
PipelineSettings 新增字段 cron_auto_trigger (bool)PUT /{repo}/-/settings/cloud-native-build:
PipelineSettings 新增字段 cron_auto_trigger (bool)POST /{repo}/-/issues:
IssueDetail 新增字段 properties ([]IssueProperty)GET /{repo}/-/issues/{number}:
IssueDetail 新增字段 properties ([]IssueProperty)PATCH /{repo}/-/issues/{number}:
IssueDetail 新增字段 properties ([]IssueProperty)DELETE /{repo}/-/issues/{number}/assignees:
IssueDetail 新增字段 properties ([]IssueProperty)PATCH /{repo}/-/issues/{number}/assignees:
IssueDetail 新增字段 properties ([]IssueProperty)POST /{repo}/-/issues/{number}/assignees:
IssueDetail 新增字段 properties ([]IssueProperty)POST /{repo}/-/issues/{number}/comment-file-asset-upload-url:
PostIssueFileAssetUploadURL → PostIssueCommentFileAssetUploadURLIssueAssetUploadURL 新增字段 name (string)POST /{repo}/-/issues/{number}/comment-image-asset-upload-url:
PostIssueImageAssetUploadURL → PostIssueCommentImageAssetUploadURLIssueAssetUploadURL 新增字段 name (string)GET /search/npc:
SearchNpcRes 新增字段 pull_request_created_count (int)SearchNpcRes 新增字段 pull_request_merged_count (int)SearchNpcRes 新增字段 built_count (int)GET /{slug}/-/outside-collaborators:
OutsideCollaboratorInRepo 新增字段 inviter (Users)GET /ranks/repo/annual:
dto.RankDetailWithIncr → dto.GetRankResulttrue → falseGET /ranks/repo/daily:
dto.RankDetailWithIncr → dto.GetRankResulttrue → falseGET /ranks/repo/monthly:
dto.RankDetailWithIncr → dto.GetRankResulttrue → falseGET /ranks/repo/weekly:
dto.RankDetailWithIncr → dto.GetRankResulttrue → falseGET /user:
UsersResult 新增字段 identity_providers ([]string)GET /users/{username}:
UsersResult 新增字段 identity_providers ([]string)0298f968| 项目 | 信息 |
|---|---|
| 新增接口 | 4 个 |
| 修改接口 | 3 个 |
| 删除接口 | 0 个 |
| ⚠️ 破坏性变更 | 有(3 处) |
本次版本共涉及 7 个接口变更,其中 3 处破坏性变更,请重点关注。
以下变更可能导致现有客户端不兼容,请优先关注。
GET /{repo}/-/top-activity-users:响应模型 UsersResult 字段 identity_providers 类型变更: []string → map[string]interface{}GET /user:响应模型 UsersResult 字段 identity_providers 类型变更: []string → map[string]interface{}GET /users/{username}:响应模型 UsersResult 字段 identity_providers 类型变更: []string → map[string]interface{}| 分类 | 方法 | 路径 | 描述 |
|---|---|---|---|
| issues | GET | /{repo}/-/files/issues/{file_path} | 获取 Issue 文件,返回文件二进制内容。Request to retrieve file of issues, returns binary content. |
| issues | GET | /{repo}/-/imgs/issues/{img_path} | 获取 Issue 图片,返回图片二进制内容。Request to retrieve image of issues, returns binary content. |
| pulls | GET | /{repo}/-/files/pulls/{file_path} | 获取合并请求文件,返回文件二进制内容。Request to retrieve file of pull requests, returns binary content. |
| pulls | GET | /{repo}/-/imgs/pulls/{img_path} | 获取合并请求图片,返回图片二进制内容。Request to retrieve image of pull requests, returns binary content. |
| 分类 | 方法 | 路径 | 变更类型 |
|---|---|---|---|
| activities | GET | /{repo}/-/top-activity-users | 模型字段变更 |
| users | GET | /user | 模型字段变更 |
| users | GET | /users/{username} | 模型字段变更 |
详细说明:
GET /{repo}/-/top-activity-users:
UsersResult 字段 identity_providers 类型变更: []string → map[string]interface{}GET /user:
UsersResult 字段 identity_providers 类型变更: []string → map[string]interface{}GET /users/{username}:
UsersResult 字段 identity_providers 类型变更: []string → map[string]interface{}
此 Issue 的作用是 追踪 CNB OpenAPI 的版本更新,并在检测到新版本发布时 自动发出提醒。