diff --git "a/doc/zh/api/\344\273\243\347\240\201\345\272\246\351\207\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" "b/doc/zh/api/\344\273\243\347\240\201\345\272\246\351\207\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" index 5a8befdb9..6ece066a1 100644 --- "a/doc/zh/api/\344\273\243\347\240\201\345\272\246\351\207\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" +++ "b/doc/zh/api/\344\273\243\347\240\201\345\272\246\351\207\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" @@ -10,20 +10,20 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| state | str | 问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | -| change_type | str | 圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | -| author | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| scan_open | int | 发现问题的扫描编号 | -| scan_close | int | 修复问题的扫描编号 | -| worse | boolean | 圈复杂度是否恶化 | -| over_cc_sum_gte | int | 圈复杂度总和最小值 | -| over_cc_sum_lte | int | 圈复杂度总和最大值 | -| over_cc_avg_gte | int | 平均圈复杂度最小值 | -| over_cc_avg_lte | int | 平均圈复杂度总和最大值 | -| over_cc_func_count_gte | int | 超标圈复杂度函数个数最小值 | -| over_cc_func_count_lte | int | 超标圈复杂度函数个数最大值 | +| state | str | 选填,问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | +| change_type | str | 选填,圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | +| author | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| scan_open | int | 选填,发现问题的扫描编号 | +| scan_close | int | 选填,修复问题的扫描编号 | +| worse | boolean | 选填,圈复杂度是否恶化 | +| over_cc_sum_gte | int |选填, 圈复杂度总和最小值 | +| over_cc_sum_lte | int | 选填,圈复杂度总和最大值 | +| over_cc_avg_gte | int | 选填,平均圈复杂度最小值 | +| over_cc_avg_lte | int | 选填,平均圈复杂度总和最大值 | +| over_cc_func_count_gte | int | 选填,超标圈复杂度函数个数最小值 | +| over_cc_func_count_lte | int | 选填,超标圈复杂度函数个数最大值 | #### 返回参数 @@ -84,13 +84,13 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| status | str | 问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | -| change_type | str | 圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | -| author | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| ccn_gte | str | 圈复杂度最小值 | -| ccn_lte | str | 圈复杂度最大值 | +| status | str | 选填,问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | +| change_type | str | 选填,圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | +| author | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| ccn_gte | str | 选填,圈复杂度最小值 | +| ccn_lte | str | 选填,圈复杂度最大值 | #### 返回结果 @@ -151,13 +151,13 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| status | str | 问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | -| change_type | str | 圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | -| author | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| ccn_gte | str | 圈复杂度最小值 | -| ccn_lte | str | 圈复杂度最大值 | +| status | str | 选填,问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | +| change_type | str | 选填,圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | +| author | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| ccn_gte | str | 选填,圈复杂度最小值 | +| ccn_lte | str | 选填,圈复杂度最大值 | #### 返回结果 @@ -218,20 +218,20 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| state | str | 问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | -| change_type | str | 圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | -| author | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| scan_open_id | int | 发现问题的扫描编号 | -| scan_close_id | int | 修复问题的扫描编号 | -| worse | boolean | 圈复杂度是否恶化 | -| over_cc_sum_gte | int | 圈复杂度总和最小值 | -| over_cc_sum_lte | int | 圈复杂度总和最大值 | -| over_cc_avg_gte | int | 平均圈复杂度最小值 | -| over_cc_avg_lte | int | 平均圈复杂度总和最大值 | -| over_cc_func_count_gte | int | 超标圈复杂度函数个数最小值 | -| over_cc_func_count_lte | int | 超标圈复杂度函数个数最大值 | +| state | str | 选填,问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | +| change_type | str | 选填,圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | +| author | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| scan_open_id | int | 选填,发现问题的扫描编号 | +| scan_close_id | int | 选填,修复问题的扫描编号 | +| worse | boolean | 选填,圈复杂度是否恶化 | +| over_cc_sum_gte | int | 选填,圈复杂度总和最小值 | +| over_cc_sum_lte | int | 选填,圈复杂度总和最大值 | +| over_cc_avg_gte | int | 选填,平均圈复杂度最小值 | +| over_cc_avg_lte | int | 选填,平均圈复杂度总和最大值 | +| over_cc_func_count_gte | int | 选填,超标圈复杂度函数个数最小值 | +| over_cc_func_count_lte | int | 选填,超标圈复杂度函数个数最大值 | #### 返回结果 @@ -295,13 +295,13 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| status | str | 问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | -| change_type | str | 圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | -| author | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| ccn_gte | str | 圈复杂度最小值 | -| ccn_lte | str | 圈复杂度最大值 | +| status | str | 选填,问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | +| change_type | str | 选填,圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | +| author | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| ccn_gte | str | 选填,圈复杂度最小值 | +| ccn_lte | str | 选填,圈复杂度最大值 | #### 返回结果 @@ -362,13 +362,13 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| status | str | 问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | -| change_type | str | 圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | -| author | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| ccn_gte | str | 圈复杂度最小值 | -| ccn_lte | str | 圈复杂度最大值 | +| status | str | 选填,问题状态,1为需要关注,2为无需关注,可多选,格式为1,2,3 | +| change_type | str | 选填,圈复杂度变化情况,0为无,1为新增,2为删除,3为无变化,可多选,格式为1,2,3 | +| author | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| ccn_gte | str | 选填,圈复杂度最小值 | +| ccn_lte | str | 选填,圈复杂度最大值 | #### 返回结果 @@ -429,13 +429,13 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| issue__state | str | 问题状态, 1为未处理,2为可忽略,3为关闭,可多选,格式为1,2,3 | -| change_type | str | 重复文件更改类型,add为新增,del为删除,mod为删除,可多选,格式为add,del,mod | -| issue__owner | str | 问题责任人 | -| last_modifier | str | 最近修改人 | -| file_path | str | 文件路径 | -| duplicate_rate_gte | int | 重复率最小值 | -| duplicate_rate_lte | int | 重复率最大值 | +| issue__state | str | 选填,问题状态, 1为未处理,2为可忽略,3为关闭,可多选,格式为1,2,3 | +| change_type | str | 选填,重复文件更改类型,add为新增,del为删除,mod为删除,可多选,格式为add,del,mod | +| issue__owner | str | 选填,问题责任人 | +| last_modifier | str | 选填,最近修改人 | +| file_path | str | 选填,文件路径 | +| duplicate_rate_gte | int | 选填,重复率最小值 | +| duplicate_rate_lte | int | 选填,重复率最大值 | #### 返回结果 @@ -590,8 +590,8 @@ GET /server/analysis/api/orgs//teams//repos//projec | 参数 | 类型 | 描述 | | --- | --- | --- | -| change_type | str | 改变类型(add、mod、del),支持多值,使用英文逗号','分隔 | -| file_path | str | 文件路径 | +| change_type | str | 选填,改变类型(add、mod、del),支持多值,使用英文逗号','分隔 | +| file_path | str | 选填,文件路径 | #### 返回结果 diff --git "a/doc/zh/api/\344\273\243\347\240\201\346\211\253\346\217\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" "b/doc/zh/api/\344\273\243\347\240\201\346\211\253\346\217\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" index fc89e3982..9cc5d9707 100644 --- "a/doc/zh/api/\344\273\243\347\240\201\346\211\253\346\217\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" +++ "b/doc/zh/api/\344\273\243\347\240\201\346\211\253\346\217\217\346\225\260\346\215\256\346\250\241\345\235\227\346\216\245\345\217\243.md" @@ -9,17 +9,17 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数 | 参数 | 类型 | 描述 | | --- | --- | --- | -| state | str | 问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | -| severity | str | 严重程度, 1为致命,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4 | -| resolution | str | 解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除 | -| author | str | 问题责任人 | -| scan_open | int | 发现问题的扫描编号 | -| scan_fix | int | 修复问题的扫描编号 | -| ci_time_gte | str | 修复问题的起始时间,格式为"2021-01-01 00:00:00" | -| ci_time_lte | str | 修复问题的结束时间 | -| file_path | str | 文件路径 | -| checkrule_display_name | str | 检查规则名 | -| checkpackage | int | 问题所属的规则包 | +| state | str | 选填,问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | +| severity | str | 选填,严重程度, 1为致命,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4 | +| resolution | str | 选填,解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除 | +| author | str | 选填,问题责任人 | +| scan_open | int | 选填,发现问题的扫描编号 | +| scan_fix | int | 选填,修复问题的扫描编号 | +| ci_time_gte | str | 选填,修复问题的起始时间,格式为"2021-01-01 00:00:00" | +| ci_time_lte | str | 选填,修复问题的结束时间 | +| file_path | str | 选填,文件路径 | +| checkrule_display_name | str | 选填,检查规则名 | +| checkpackage | int | 选填,问题所属的规则包 | #### 返回结果 ```JSON @@ -143,17 +143,17 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数 | 参数 | 类型 | 描述 | | --- | --- | --- | -| state | str | 问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | -| severity | str | 严重程度, 1为致命,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4 | -| resolution | str | 解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除 | -| author | str | 问题责任人 | -| scan_open_id | int | 发现问题的扫描编号 | -| scan_fix_id | int | 修复问题的扫描编号 | -| ci_time_gte | str | 修复问题的起始时间 | -| ci_time_lte | str | 修复问题的结束时间 | -| file_path | str | 文件路径 | -| checkrule_display_name | str | 检查规则名 | -| checkpackage | int | 问题所属的规则包 | +| state | str | 选填,问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | +| severity | str | 选填,严重程度, 1为致命,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4 | +| resolution | str | 选填,解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除 | +| author | str | 选填,问题责任人 | +| scan_open_id | int | 选填,发现问题的扫描编号 | +| scan_fix_id | int | 选填,修复问题的扫描编号 | +| ci_time_gte | str | 选填,修复问题的起始时间 | +| ci_time_lte | str | 选填,修复问题的结束时间 | +| file_path | str | 选填,文件路径 | +| checkrule_display_name | str | 选填,检查规则名 | +| checkpackage | int | 选填,问题所属的规则包 | #### 返回结果 ```JSON @@ -212,17 +212,17 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数 | 参数 | 类型 | 描述 | | --- | --- | --- | -| state | str | 问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | -| severity | str | 严重程度, 1为致命,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4 | -| resolution | str | 解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除 | -| author | str | 问题责任人 | -| scan_open_id | int | 发现问题的扫描编号 | -| scan_fix_id | int | 修复问题的扫描编号 | -| ci_time_gte | str | 修复问题的起始时间 | -| ci_time_lte | str | 修复问题的结束时间 | -| file_path | str | 文件路径 | -| checkrule_display_name | str | 检查规则名 | -| checkpackage | int | 问题所属的规则包 | +| state | str | 选填,问题状态, 1为未处理,2为已处理,3为关闭,可多选,格式为1,2,3 | +| severity | str | 选填,严重程度, 1为致命,2为错误,3为警告,4为提示,可多选,格式为1,2,3,4 | +| resolution | str | 选填,解决方式, 0为无,1为修复,2为无需修复,3为误报,4为重复单过滤,5为路径过滤,6为规则移除 | +| author | str | 选填,问题责任人 | +| scan_open_id | int | 选填,发现问题的扫描编号 | +| scan_fix_id | int | 选填,修复问题的扫描编号 | +| ci_time_gte | str | 选填,修复问题的起始时间 | +| ci_time_lte | str | 选填,修复问题的结束时间 | +| file_path | str | 选填,文件路径 | +| checkrule_display_name | str | 选填,检查规则名 | +| checkpackage | int | 选填,问题所属的规则包 | #### 返回结果 ```JSON @@ -271,4 +271,4 @@ GET /server/analysis/api/orgs//teams//repos//projec "msg": "xxx", "status_code": 200 } -``` \ No newline at end of file +``` diff --git "a/doc/zh/api/\344\273\273\345\212\241\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" "b/doc/zh/api/\344\273\273\345\212\241\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" index ca0a56a4a..fb8e93b48 100644 --- "a/doc/zh/api/\344\273\273\345\212\241\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" +++ "b/doc/zh/api/\344\273\273\345\212\241\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" @@ -9,9 +9,9 @@ POST /server/main/api/orgs//teams//repos//projects/ #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| incr_scan | bool | 增量扫描标志,true表示增量,false表示全量 | -| async_flag | bool | 异步启动标志,true表示异步,false表示同步,建议选择异步 | -| force_create | bool | 强制启动标志,true表示强制启动,不等待上一个任务结束 | +| incr_scan | bool | 选填,增量扫描标志,true表示增量,false表示全量 | +| async_flag | bool | 选填,异步启动标志,true表示异步,false表示同步,建议选择异步 | +| force_create | bool | 选填,强制启动标志,true表示强制启动,不等待上一个任务结束 | #### 返回结果 ```JSON @@ -34,14 +34,14 @@ GET /server/main/api/orgs//teams//repos//projects/< | 参数 | 类型 | 描述 | | --- | --- | --- | -| create_time_gte | datetime | 最小任务启动时间 | -| create_time_lte | datetime | 最大任务启动时间 | -| result_code_gte | int | 最小错误码值 | -| result_code_lte | int | 最大错误码值 | -| result_msg | str | 结果信息 | -| state | int | 任务状态, 0为等待中,1为执行中,2为关闭,3为入库中,可多选,格式为1,2,3 | -| created_from | str | 创建来源 | -| creator | str | 创建用户 | +| create_time_gte | datetime | 选填,最小任务启动时间 | +| create_time_lte | datetime | 选填,最大任务启动时间 | +| result_code_gte | int | 选填,最小错误码值 | +| result_code_lte | int | 选填,最大错误码值 | +| result_msg | str | 选填,结果信息 | +| state | int | 选填,任务状态, 0为等待中,1为执行中,2为关闭,3为入库中,可多选,格式为1,2,3 | +| created_from | str | 选填,创建来源 | +| creator | str | 选填,创建用户 | #### 返回结果 diff --git "a/doc/zh/api/\347\273\223\346\236\234\346\246\202\350\247\210\346\250\241\345\235\227\346\216\245\345\217\243.md" "b/doc/zh/api/\347\273\223\346\236\234\346\246\202\350\247\210\346\250\241\345\235\227\346\216\245\345\217\243.md" index bcbbfe638..4ffaba12b 100644 --- "a/doc/zh/api/\347\273\223\346\236\234\346\246\202\350\247\210\346\250\241\345\235\227\346\216\245\345\217\243.md" +++ "b/doc/zh/api/\347\273\223\346\236\234\346\246\202\350\247\210\346\250\241\345\235\227\346\216\245\345\217\243.md" @@ -278,7 +278,7 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scan_revision | str | 指定查询的扫描版本号,如不指定则为当前项目最新的一次扫描 | +| scan_revision | str | 选填,指定查询的扫描版本号,如不指定则为当前项目最新的一次扫描 | #### 返回结果 ```JSON @@ -459,8 +459,8 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scan_time_before | str | 扫描任务起始时间,格式: 2021-01-01 00:00:00 | -| scan_time_after | str | 扫描任务结束时间 | +| scan_time_before | str | 选填,扫描任务起始时间,格式: 2021-01-01 00:00:00 | +| scan_time_after | str | 选填,扫描任务结束时间 | #### 返回结果 ```JSON @@ -623,8 +623,8 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scan_time_before | str | 扫描任务起始时间,格式: 2021-01-01 00:00:00 | -| scan_time_after | str | 扫描任务结束时间 | +| scan_time_before | str | 选填,扫描任务起始时间,格式: 2021-01-01 00:00:00 | +| scan_time_after | str | 选填,扫描任务结束时间 | #### 返回结果 ```JSON @@ -682,8 +682,8 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scan_time_before | str | 扫描任务起始时间,格式: 2021-01-01 00:00:00 | -| scan_time_after | str | 扫描任务结束时间 | +| scan_time_before | str | 选填,扫描任务起始时间,格式: 2021-01-01 00:00:00 | +| scan_time_after | str | 选填,扫描任务结束时间 | #### 返回结果 ```JSON @@ -773,8 +773,8 @@ GET /server/analysis/api/orgs//teams//repos//projec #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scan_time_before | str | 扫描任务起始时间,格式: 2021-01-01 00:00:00 | -| scan_time_after | str | 扫描任务结束时间 | +| scan_time_before | str | 选填,扫描任务起始时间,格式: 2021-01-01 00:00:00 | +| scan_time_after | str | 选填,扫描任务结束时间 | #### 返回结果 ```JSON diff --git "a/doc/zh/api/\351\241\271\347\233\256\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" "b/doc/zh/api/\351\241\271\347\233\256\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" index 62574b89f..871fd7564 100644 --- "a/doc/zh/api/\351\241\271\347\233\256\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" +++ "b/doc/zh/api/\351\241\271\347\233\256\347\256\241\347\220\206\346\250\241\345\235\227\346\216\245\345\217\243.md" @@ -9,9 +9,9 @@ GET /server/main/api/orgs//teams//repos/ #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scm_url_or_name | str | 代码库地址或者名称,支持模糊匹配 | -| scm_url | str | 代码库仓库匹配| -| scope | str | 过滤范围(my/subscribed/related_me),my表示我创建的,subscribed表示我关注的,related_me表示我有权限的 | +| scm_url_or_name | str | 选填,代码库地址或者名称,支持模糊匹配 | +| scm_url | str | 选填,代码库仓库匹配| +| scope | str | 选填,过滤范围(my/subscribed/related_me),my表示我创建的,subscribed表示我关注的,related_me表示我有权限的 | #### 返回结果 ```JSON @@ -134,7 +134,7 @@ POST /server/main/api/orgs//teams//repos/ | scm_type | str | 必填,git或svn | | ssh_url | str | 选填,代码库SSH地址 | | name | str | 选填, 代码库名称 | -| scm_auth | dict | 代码库授权 | +| scm_auth | dict | 选填,代码库授权 | 例子: @@ -266,11 +266,11 @@ GET /server/main/api/orgs//teams//repos//projects/ #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| branch | str | 分支名称 | -| scan_scheme | int | 扫描方案名称 | -| scan_scheme__status | int | 扫描方案状态,1为活跃,2为废弃 | -| branch_or_scheme | str | 分支名称/扫描方案名称 | -| status | int | 项目状态筛选,1表示活跃,2表示失活,3表示关闭 | +| branch | str | 选填,分支名称 | +| scan_scheme | int | 选填,扫描方案名称 | +| scan_scheme__status | int | 选填,扫描方案状态,1为活跃,2为废弃 | +| branch_or_scheme | str | 选填,分支名称/扫描方案名称 | +| status | int | 选填,项目状态筛选,1表示活跃,2表示失活,3表示关闭 | #### 返回结果 ```JSON @@ -353,11 +353,11 @@ POST /server/main/api/orgs//teams//repos//projects/ #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| scan_scheme_id | int | 当前代码库的扫描方案编号 | -| global_scheme_id | int | 扫描方案模板编号 | -| custom_scheme_name | str | 自定义方案名称 | -| branch | str | 分支 | -| created_from | str | 创建渠道,用于区分不同运行场景 | +| scan_scheme_id | int | 和global_scheme_id二选一进行填写,当前代码库的扫描方案编号 | +| global_scheme_id | int | 和scan_scheme_id二选一进行填写,扫描方案模板编号 | +| custom_scheme_name | str | 选填,自定义方案名称 | +| branch | str | 必填,分支 | +| created_from | str | 选填,创建渠道,用于区分不同运行场景 | #### 返回结果 ```JSON @@ -454,7 +454,7 @@ POST /server/main/api/orgs//teams//repos//projects/ ## 查看指定代码库的指定分析项目 ``` -GET /server/main/api/orgs//teams//repos/// +GET /server/main/api/orgs//teams//repos//projects// ``` #### 返回结果 @@ -557,8 +557,8 @@ GET /server/main/api/orgs//teams//repos//schemes/ #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| name | str | 扫描方案名称 | -| status | int | 扫描方案状态,1为活跃,2为废弃 | +| name | str | 选填,扫描方案名称 | +| status | int | 选填,扫描方案状态,1为活跃,2为废弃 | #### 返回结果 ```JSON @@ -669,21 +669,21 @@ PUT /server/main/api/orgs//teams//repos//schemes//teams//repos//schemes//teams//repos//schemes//teams//repos//schemes/< #### 参数列表 | 参数 | 类型 | 描述 | | --- | --- | --- | -| dir_path |str | 指定过滤路径 | -| path_type | int | 路径格式,1表示通配符,2表示正则表达式,默认为通配符 | -| scan_type | int | 扫描类型,1表示包含,2表示排除 | +| dir_path |str | 必填,指定过滤路径 | +| path_type | int | 选填,路径格式,1表示通配符,2表示正则表达式,默认为通配符 | +| scan_type | int | 选填,扫描类型,1表示包含,2表示排除 | #### 返回结果 ```JSON @@ -867,9 +867,9 @@ PUT /server/main/api/orgs//teams//repos//schemes/