提交修改的源码文件 - SubmitDefectsFileContent
功能介绍
提交修改后的代码到代码仓。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| codeartscheck:task:getReport | Read | task * | - | - | - |
| - | codeartscheck:ProjectId |
URI
PUT /v1/defects/file-content
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目的32位UUID,通过查询项目列表接口获取。 约束限制: 不涉及。 取值范围: 32位UUID。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Language | 否 | String | 参数解释: 语言,决定响应以哪种语言返回。 约束限制: 不涉及。 取值范围: 默认取值: zh-cn。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| taskId | 是 | String | 参数解释: 任务ID,即新建检查任务接口的返回值,每个代码检查任务及其下的分支任务、通过API创建的增量任务都有唯一的任务ID。即查询任务列表接口响应中的id字段。 约束限制: 不涉及。 取值范围: 长度为[1~32]个字符。 默认取值: 不涉及。 |
| jobId | 否 | String | 参数解释: 执行ID,来自代码检查执行任务接口的返回值,每次执行代码检查任务都有唯一的执行ID。版本级不传,门禁级必传。即“根据任务ID查询任务执行记录”的响应中的ID字段。 约束限制: 不涉及。 取值范围: 长度为[1~32]个字符。 默认取值: 不涉及。 |
| mergeId | 否 | String | 参数解释: 合并请求ID。实际仅用于区分版本级和门禁级,版本级不传,门禁级传任意非空值即可。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| mergeKey | 是 | String | 参数解释: MergeKey,问题ID。获取代码问题列表响应中的mergeKey字段。 约束限制: 不涉及。 取值范围: 长度为[1~32]个字符。 默认取值: 不涉及。 |
| bugId | 是 | String | 参数解释: bugId,问题代码片段ID。即“获取代码问题列表”响应中的bugId 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| occursMd5 | 是 | String | 参数解释: occursMd5,智能化分析后,生成的md5值。即“智能化分析告警”中的occursMd5字段。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| content | 是 | String | 参数解释: 提交到代码仓的内容。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| message | 是 | String | 参数解释: 提交到代码仓的commit描述。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| status | String | 参数解释: 响应状态。 取值范围: |
| result | String | 参数解释: 修改结果。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
状态码:401
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码。 取值范围: 不涉及。 |
| error_msg | String | 参数解释: 错误描述。 取值范围: 不涉及。 |
请求示例
PUT https://{endpoint}/v1/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/v1/defects/file-content 响应示例
状态码:200
Request succeeded!
{
"status" : "success",
"error" : null,
"result" : null
} 状态码:400
请求异常。
{
"error_code" : "CC.xxxxxxxx.400",
"error_msg" : "请求参数校验失败,请检查请求参数是否正确"
} 状态码:401
权限不足。
{
"error_code" : "CC.00000003",
"error_msg" : "认证信息过期"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | Request succeeded! |
| 400 | 请求异常。 |
| 401 | 权限不足。 |
错误码
请参见错误码。