huawei-cloud-api-definitions-CodeCheck 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"ErrorResponse":{"properties":{"error_code":{"description":"错误码","example":"CC.00000000","type":"string"},"error_msg":{"description":"错误描述","example":"网络繁忙,请稍后再试","type":"string"}}},"TaskInfoV2":{"properties":{"check_type":{"description":"检查类型","example":"source","type":"string"},"code_line":{"description":"代码有效行数","example":5685,"type":"integer"},"code_line_total":{"description":"代码总行数","example":63371,"type":"integer"},"code_quality":{"description":"代码质量","example":147.3,"type":"number"},"comment_lines":{"description":"注释行数","example":0,"type":"integer"},"comment_ratio":{"description":"注释比例","example":0,"type":"string"},"complexity_count":{"description":"复杂度","example":0,"type":"integer"},"created_at":{"description":"创建时间","example":"2020-02-20 11:21:11","type":"string"},"creator_id":{"description":"创建者id","example":"a2b9a42ee649xxxx94f5655f8535920e","type":"string"},"critical_count":{"description":"致命问题数","example":0,"type":"string"},"cyclomatic_complexity_per_file":{"description":"代码平均复杂度(文件)","example":"112.0","type":"string"},"cyclomatic_complexity_per_method":{"description":"代码平均复杂度","example":"84.0","type":"string"},"duplicated_blocks":{"description":"重复块","example":0,"type":"integer"},"duplicated_lines":{"description":"重复行数","example":0,"type":"integer"},"duplication_ratio":{"description":"重复比例","example":"0.0%","type":"string"},"file_duplication_ratio":{"description":"文件重复率","example":"33.3%","type":"string"},"git_branch":{"description":"代码仓分支,如果是MR模式,为源分支","example":"portal-ts","type":"string"},"git_url":{"description":"代码仓地址","example":"https://codehub.alpha.devcloud.inhuawei.com/******","type":"string"},"is_access":{"description":"门禁质量是否通过","example":1,"type":"string"},"issue_count":{"description":"问题数","example":3,"type":"integer"},"last_check_time":{"description":"上一次检查时间","example":"2020-02-20 11:37:46","type":"string"},"last_exec_time":{"description":"上次执行时间","example":"2 分 28 秒","type":"string"},"major_count":{"description":"严重问题数","example":0,"type":"string"},"minor_count":{"description":"一般问题数","example":0,"type":"string"},"risk_coefficient":{"description":"危险系数","example":23,"type":"number"},"suggestion_count":{"description":"提示问题数","example":0,"type":"string"},"task_id":{"description":"任务id","example":"b9db371361724xxxx6937f3280df1d4fc4","type":"string"},"task_name":{"description":"任务名字","example":"test","type":"string"},"trigger_type":{"description":"任务触发方式","example":0,"type":"string"}}}},"description":null,"group_id":"6e24e1d8225c45beaaeeceee605429ba","host":"codecheck-ext.cn-north-4.myhuaweicloud.com","id":"9f210e5dbba84a309501e8ecc5549cfb","info_version":"v2","method":"get","name":"ShowTaskDetail","parameters":{},"paths":{"/v2/tasks/{task_id}/defects-summary":{"get":{"consumes":["application/json"],"deprecated":false,"description":"根据检查任务ID查询缺陷结果的概要。包括问题概述、问题状态、圈复杂度、代码重复率等。","operationId":"ShowTaskDetail","parameters":[{"description":"通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":100000,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"MIIDkgYJKoZIhvcNAQcCoIIDgzCCXXXXX..."},{"description":"任务ID","in":"path","name":"task_id","required":true,"type":"string","x-example":"2b31ed520xxxxxxebedb6e57xxxxxxxx"}],"produces":["application/json"],"responses":{"200":{"description":"Request succeeded!","examples":{"application/json":{"check_type":"source","code_line":156,"code_line_total":20,"code_quality":147.4,"comment_lines":0,"comment_ratio":"0","complexity_count":0,"created_at":"2020-02-20 11:21:11","creator_id":"ecadebb5041146cc96f9780f3d905e20","critical_count":2,"cyclomatic_complexity_per_file":"112.0","cyclomatic_complexity_per_method":"84.0","duplicated_blocks":0,"duplicated_lines":0,"duplication_ratio":"0.0%","file_duplication_ratio":"33.3%","git_branch":"master","git_url":"git@codehub.dev****_02201119.git","is_access":0,"issue_count":3,"last_check_time":"2020-02-20 11:37:46","last_exec_time":"2 分 28 秒","major_count":1,"minor_count":1,"risk_coefficient":23,"suggestion_count":1,"task_id":"435b58ecf7f54c45907c1384d01c94a6","task_name":"CSharp_02201119","trigger_type":1}},"schema":{"$ref":"#/definitions/TaskInfoV2"}},"400":{"description":"Bad Request","examples":{"application/json":{"error_code":"CC.00000000","error_msg":"网络繁忙,请稍后再试"}},"schema":{"$ref":"#/definitions/ErrorResponse"}},"401":{"description":"Unauthorized","examples":{"application/json":{"error_code":"CC.00000003","error_msg":"认证信息过期"}},"schema":{"$ref":"#/definitions/ErrorResponse"}}},"security":[{"apig-auth-iam":[]}],"summary":"查询缺陷概要","tags":["缺陷管理"],"x-apigateway-backend":{"httpEndpoints":{"address":"10.63.38.190:40115","description":"","method":"GET","path":"/codecheck/v2/tasks/{task_id}/defects-summary","scheme":"https","timeout":60000},"parameters":[{"description":"逻辑region","in":"HEADER","name":"X-AUTH-REGION","origin":"CONSTANT","value":"cn-north-7"},{"description":"任务ID","in":"PATH","name":"task_id","origin":"REQUEST","value":"task_id"}],"type":"HTTP"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-request-type":"public","x-is-registered":"Y","x-name":"查询任务详情","x-request-examples-1":"GET https://{endpoint}/v2/tasks/2b31ed520xxxxxxebedb6e57xxxxxxxx/defects-summary","x-request-examples-description-1":"","x-support-sdk":"Y","x-version":"v2"}}},"product_short":"CodeCheck","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"查询缺陷概要","tags":"缺陷管理","uri":null,"version":"2.0"}