Skip to content

Commit

Permalink
Update 代码度量数据模块接口.md
Browse files Browse the repository at this point in the history
增加“api参数是否必填”的提示
  • Loading branch information
yyyangw authored Jul 1, 2024
1 parent 73ef2ab commit 076b3e5
Showing 1 changed file with 65 additions and 65 deletions.
130 changes: 65 additions & 65 deletions doc/zh/api/代码度量数据模块接口.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,20 +10,20 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,超标圈复杂度函数个数最大值 |

#### 返回参数

Expand Down Expand Up @@ -84,13 +84,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,圈复杂度最大值 |

#### 返回结果

Expand Down Expand Up @@ -151,13 +151,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,圈复杂度最大值 |

#### 返回结果

Expand Down Expand Up @@ -218,20 +218,20 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,超标圈复杂度函数个数最大值 |

#### 返回结果

Expand Down Expand Up @@ -295,13 +295,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,圈复杂度最大值 |

#### 返回结果

Expand Down Expand Up @@ -362,13 +362,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,圈复杂度最大值 |

#### 返回结果

Expand Down Expand Up @@ -429,13 +429,13 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/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 | 选填,重复率最大值 |

#### 返回结果

Expand Down Expand Up @@ -590,8 +590,8 @@ GET /server/analysis/api/orgs/<org_sid>/teams/<team_name>/repos/<repo_id>/projec

| 参数 | 类型 | 描述 |
| --- | --- | --- |
| change_type | str | 改变类型(add、mod、del),支持多值,使用英文逗号','分隔 |
| file_path | str | 文件路径 |
| change_type | str | 选填,改变类型(add、mod、del),支持多值,使用英文逗号','分隔 |
| file_path | str | 选填,文件路径 |

#### 返回结果

Expand Down

0 comments on commit 076b3e5

Please sign in to comment.