huawei-cloud-api-definitions-CodeCheck 0.1.20240402

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"","definitions":{"DefectEvents":{"properties":{"code_context":{"description":"code context","example":"","type":"string"},"code_context_start_line":{"description":"缺陷开始行","example":11,"type":"integer"},"description":{"description":"描述","example":"","type":"string"},"end_line":{"description":"缺陷结束行","example":22,"type":"integer"},"events":{"description":"调用链信息","items":{"$ref":"#/definitions/DefectEvents"},"type":"array"},"fix_suggestions":{"description":"fix suggestions","items":{"type":"string"},"type":"array"},"line":{"description":"缺陷所在行","example":11,"type":"integer"},"main":{"description":"代码片段","example":true,"type":"boolean"},"main_buggy_code":{"description":"main buggy code","example":"path","type":"string"},"path":{"description":"file path","example":"","type":"string"},"tag":{"description":"标签","example":"path","type":"string"}}},"DefectFragmentV2":{"description":"start_offset和end_offset均为-1,表示该行不是缺陷片段或者整行都是,需要结合DefectInfoV2中的line_number属性一起判断哪一行是具体的缺陷片段。","properties":{"end_offset":{"description":"缺陷结束列号","example":-1,"type":"integer"},"line_content":{"description":"该行代码内容","example":"    export function padding(all: number);","type":"string"},"line_num":{"description":"行号","example":"78","type":"string"},"start_offset":{"description":"缺陷开始列号","example":-1,"type":"integer"}}},"DefectInfoV2":{"description":"缺陷信息","properties":{"created_at":{"description":"创建时间","example":"2020-10-26T06:24:15Z","type":"string"},"defect_checker_name":{"description":"缺陷对应检查项的名称","example":"Expected a break statement before default","type":"string"},"defect_content":{"description":"缺陷描述","example":"Update or refactor this function so that its implementation doesn't duplicate the one on line 60.","type":"string"},"defect_id":{"description":"缺陷的id","example":"b04be5fa29c94f6580375124a857dc25","type":"string"},"defect_level":{"description":"缺陷等级,0致命,1严重,2一般,3提示","example":"0","type":"string"},"defect_status":{"description":"缺陷的状态0为解决 1已解决 2已忽略","example":"0","type":"string"},"events":{"description":"调用链信息","items":{"$ref":"#/definitions/DefectEvents"},"type":"array"},"file_path":{"description":"缺陷文件路径","example":"code/types/functions.ts","type":"string"},"fragment":{"description":"缺陷代码片段详情","items":{"$ref":"#/definitions/DefectFragmentV2"},"type":"array"},"issue_key":{"description":"问题唯一标识","example":"AA76E96XXXXXXXXXXXXXXXXXCAAE5","type":"string"},"line_number":{"description":"缺陷所在文件行号","example":"81","type":"string"},"rule_name":{"description":"规则名","example":"FossScan.1 OpenSource Software","type":"string"},"rule_system_tags":{"description":"规则标签,多个标签用逗号隔开","example":"fossscan,findbugs","type":"string"}}},"ErrorResponse":{"properties":{"error_code":{"description":"错误码","example":"CC.00000000","type":"string"},"error_msg":{"description":"错误描述","example":"网络繁忙,请稍后再试","type":"string"}}},"ShowDefectsDetailResponseV2":{"properties":{"defects":{"description":"缺陷详情信息","items":{"$ref":"#/definitions/DefectInfoV2"},"type":"array"},"total":{"description":"总数","example":2,"type":"integer"}}}},"description":null,"group_id":"6e24e1d8225c45beaaeeceee605429ba","host":"codecheck-ext.cn-north-4.myhuaweicloud.com","id":"cc13836103504b448089b03775c8c72e","info_version":"v2","method":"get","name":"ShowTaskDefects","parameters":{},"paths":{"/v2/tasks/{task_id}/defects-detail":{"get":{"consumes":["application/json"],"deprecated":false,"description":"根据检查任务ID分页查询缺陷结果详情。","operationId":"ShowTaskDefects","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"},{"allowEmptyValue":true,"default":0,"description":"分页索引,偏移量","format":"int32","in":"query","minimum":0,"name":"offset","type":"integer","x-example":1},{"allowEmptyValue":true,"default":10,"description":"每页显示的数量,每页最多显示100条","format":"int32","in":"query","maximum":100,"minimum":1,"name":"limit","type":"integer","x-example":1},{"allowEmptyValue":true,"description":"问题状态筛选","in":"query","name":"status_ids","type":"string","x-example":-1},{"allowEmptyValue":true,"description":"严重级别,0致命,1严重,2一般,3提示","in":"query","name":"severity","type":"string","x-example":-1}],"produces":["application/json"],"responses":{"200":{"description":"Request succeeded!","examples":{"application/json":{"defects":[{"created_at":"2020-07-21T02:12:01Z","defect_checker_name":"Disallow fallthrough of `case` statements","defect_content":"Update or refactor this function so that its implementation doesn't duplicate the one on line 60.","defect_id":"5b71a4594bcb4a69a33f576c3564e6cc","defect_level":"1","defect_status":"0","file_path":"code/types/functions.ts","fragment":[{"end_offset":-1,"line_content":"    export function padding(all: number);","line_num":"78","start_offset":-1},{"end_offset":-1,"line_content":"    export function padding(topAndBottom: number, leftAndRight: number);","line_num":"79","start_offset":-1},{"end_offset":-1,"line_content":"    export function padding(top: number, right: number, bottom: number, left: number);","line_num":"80","start_offset":-1},{"end_offset":19,"line_content":"    export function padding(a: number, b?: number, c?: number, d?: number) {","line_num":"81","start_offset":11},{"end_offset":-1,"line_content":"        if (b === undefined && c === undefined && d === undefined) {","line_num":"82","start_offset":-1}],"issue_key":"AA76E96XXXXXXXXXXXXXXXXXCAAE5","line_number":"81","rule_name":"FossScan.1 OpenSource Software","rule_system_tags":"fossscan"},{"created_at":"2020-07-21T02:12:01Z","defect_checker_name":"Disallow fallthrough of `case` statements","defect_content":"Update or refactor this function so that its implementation doesn't duplicate the one on line 173.","defect_id":"5b71a4594wtrfsgrew546t466c3564e6cc","defect_level":"1","defect_status":"0","file_path":"code/types/types.ts","fragment":[{"end_offset":-1,"line_content":"    var _value;","line_num":"187","start_offset":-1},{"end_offset":-1,"line_content":"    function getOrSet(): number;","line_num":"188","start_offset":-1},{"end_offset":-1,"line_content":"    function getOrSet(value: number);","line_num":"189","start_offset":-1},{"endOffset":12,"line_content":" \"    function getOrSet(value?: number) {\"","line_num":"190","startOffset":4},{"end_offset":-1,"line_content":" \"        if (value === undefined) {\"","line_num":"191","start_offset":-1}],"issue_key":"AA76E96XXXXXXXXXXXXXXXXXFE3B6","line_number":"190","rule_name":"FossScan.1 OpenSource Software","rule_system_tags":"fossscan"}],"total":2}},"schema":{"$ref":"#/definitions/ShowDefectsDetailResponseV2"}},"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-detail","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"},{"description":"分页索引","in":"query","name":"offset","origin":"REQUEST","value":"offset"},{"description":"每页条目数","in":"query","name":"limit","origin":"REQUEST","value":"limit"}],"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"}