Skip to content

Commit ec192fd

Browse files
waterdrinkiwanghc
waterdrink
authored and
iwanghc
committed
优化Swagger文档，移除多余的@description注释，简化描述内容以提高可读性。
1 parent 72be1a8 commit ec192fd

File tree

4 files changed

+92
-104
lines changed

4 files changed

+92
-104
lines changed

‎sqle/api/controller/v1/sql_rewriting.go‎

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,49 +6,45 @@ import (
66
)
77

88
type RewriteSQLReq struct {
9-
// @Description 是否启用结构化类型的重写
9+
// 是否启用结构化类型的重写
1010
EnableStructureType bool `json:"enable_structure_type" example:"false" default:"false"`
1111
}
1212

1313
type RewriteSQLData struct {
14-
// @Description 重写前的SQL业务描述
14+
// 重写前的SQL业务描述
1515
BusinessDesc string `json:"business_desc"`
16-
// @Description 重写前的SQL执行逻辑描述
16+
// 重写前的SQL执行逻辑描述
1717
LogicDesc string `json:"logic_desc"`
18-
// @Description 重写建议列表
18+
// 重写建议列表
1919
Suggestions []*RewriteSuggestion `json:"suggestions"`
20-
// @Description 重写后的SQL
20+
// 重写后的SQL
2121
RewrittenSQL string `json:"rewritten_sql"`
22-
// @Description 重写后的SQL业务描述
22+
// 重写后的SQL业务描述
2323
RewrittenSQLBusinessDesc string `json:"rewritten_sql_business_desc"`
24-
// @Description 重写后的SQL执行逻辑描述
24+
// 重写后的SQL执行逻辑描述
2525
RewrittenSQLLogicDesc string `json:"rewritten_sql_logic_desc"`
26-
// @Description 重写前后的业务不等价性描述，为空表示等价
26+
// 重写前后的业务不等价性描述，为空表示等价
2727
BusinessNonEquivalentDesc string `json:"business_non_equivalent_desc"`
2828

2929
// TODO: 重写SQL的审核结果
3030
}
3131

3232
type RewriteSuggestion struct {
33-
// @Description 审核规则名称
34-
// @Required
33+
// 审核规则名称
3534
RuleName string `json:"rule_name"`
36-
// @Description 审核规则等级
37-
// @Required
35+
// 审核规则等级
3836
AuditLevel string `json:"audit_level" enums:"normal,notice,warn,error"`
39-
// @Description 重写建议类型：语句级重写、结构级重写、其他
40-
// @Required
37+
// 重写建议类型：语句级重写、结构级重写、其他
4138
Type string `json:"type" enums:"statement,structure,other"`
42-
// @Description 重写描述（适用于所有类型）
43-
// @Required
39+
// 重写描述（适用于所有类型）
4440
Desc string `json:"desc"`
45-
// @Description 处理状态：初始化、已处理
41+
// 处理状态：初始化、已处理
4642
Status string `json:"status" enums:"initial,processed" default:"initial"`
47-
// @Description 重写后的SQL（适用于语句级重写和结构级重写）
43+
// 重写后的SQL（适用于语句级重写和结构级重写）
4844
RewrittenSQL string `json:"rewritten_sql"`
49-
// @Description 数据库结构变更建议说明（例如：建议添加索引、修改表结构等优化建议）（适用于结构级重写）
45+
// 数据库结构变更建议说明（例如：建议添加索引、修改表结构等优化建议）（适用于结构级重写）
5046
DDL_DCL_desc string `json:"ddl_dcl_desc"`
51-
// @Description 具体的数据库结构变更语句，需要在数据库中执行该变更语句之后再应用重写SQL（包含CREATE/ALTER/DROP等DDL语句，或SET等DCL语句）（适用于结构级重写）
47+
// 具体的数据库结构变更语句，需要在数据库中执行该变更语句之后再应用重写SQL（包含CREATE/ALTER/DROP等DDL语句，或SET等DCL语句）（适用于结构级重写）
5248
DDL_DCL string `json:"ddl_dcl"`
5349
}
5450

@@ -59,19 +55,19 @@ type RewriteSQLRes struct {
5955

6056
// AsyncRewriteTask 异步重写任务（Controller层定义）
6157
type AsyncRewriteTask struct {
62-
// @Description 任务ID
58+
// 任务ID
6359
TaskID string `json:"task_id"`
64-
// @Description SQL编号
60+
// SQL编号
6561
SQLNumber string `json:"sql_number"`
66-
// @Description 任务状态
62+
// 任务状态
6763
Status string `json:"status" enums:"pending,running,completed,failed"`
68-
// @Description 错误信息
64+
// 错误信息
6965
ErrorMessage string `json:"error_message,omitempty"`
70-
// @Description 开始时间
66+
// 开始时间
7167
StartTime string `json:"start_time"`
72-
// @Description 结束时间
68+
// 结束时间
7369
EndTime *string `json:"end_time,omitempty"`
74-
// @Description 重写结果
70+
// 重写结果
7571
Result *RewriteSQLData `json:"result,omitempty"`
7672
}
7773

‎sqle/docs/docs.go‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12511,28 +12511,28 @@ var doc = `{
1251112511
"type": "object",
1251212512
"properties": {
1251312513
"end_time": {
12514-
"description": "@Description 结束时间",
12514+
"description": "结束时间",
1251512515
"type": "string"
1251612516
},
1251712517
"error_message": {
12518-
"description": "@Description 错误信息",
12518+
"description": "错误信息",
1251912519
"type": "string"
1252012520
},
1252112521
"result": {
12522-
"description": "@Description 重写结果",
12522+
"description": "重写结果",
1252312523
"type": "object",
1252412524
"$ref": "#/definitions/v1.RewriteSQLData"
1252512525
},
1252612526
"sql_number": {
12527-
"description": "@Description SQL编号",
12527+
"description": "SQL编号",
1252812528
"type": "string"
1252912529
},
1253012530
"start_time": {
12531-
"description": "@Description 开始时间",
12531+
"description": "开始时间",
1253212532
"type": "string"
1253312533
},
1253412534
"status": {
12535-
"description": "@Description 任务状态",
12535+
"description": "任务状态",
1253612536
"type": "string",
1253712537
"enum": [
1253812538
"pending",
@@ -12542,7 +12542,7 @@ var doc = `{
1254212542
]
1254312543
},
1254412544
"task_id": {
12545-
"description": "@Description 任务ID",
12545+
"description": "任务ID",
1254612546
"type": "string"
1254712547
}
1254812548
}
@@ -18071,31 +18071,31 @@ var doc = `{
1807118071
"type": "object",
1807218072
"properties": {
1807318073
"business_desc": {
18074-
"description": "@Description 重写前的SQL业务描述",
18074+
"description": "重写前的SQL业务描述",
1807518075
"type": "string"
1807618076
},
1807718077
"business_non_equivalent_desc": {
18078-
"description": "@Description 重写前后的业务不等价性描述，为空表示等价",
18078+
"description": "重写前后的业务不等价性描述，为空表示等价",
1807918079
"type": "string"
1808018080
},
1808118081
"logic_desc": {
18082-
"description": "@Description 重写前的SQL执行逻辑描述",
18082+
"description": "重写前的SQL执行逻辑描述",
1808318083
"type": "string"
1808418084
},
1808518085
"rewritten_sql": {
18086-
"description": "@Description 重写后的SQL",
18086+
"description": "重写后的SQL",
1808718087
"type": "string"
1808818088
},
1808918089
"rewritten_sql_business_desc": {
18090-
"description": "@Description 重写后的SQL业务描述",
18090+
"description": "重写后的SQL业务描述",
1809118091
"type": "string"
1809218092
},
1809318093
"rewritten_sql_logic_desc": {
18094-
"description": "@Description 重写后的SQL执行逻辑描述",
18094+
"description": "重写后的SQL执行逻辑描述",
1809518095
"type": "string"
1809618096
},
1809718097
"suggestions": {
18098-
"description": "@Description 重写建议列表",
18098+
"description": "重写建议列表",
1809918099
"type": "array",
1810018100
"items": {
1810118101
"$ref": "#/definitions/v1.RewriteSuggestion"
@@ -18107,7 +18107,7 @@ var doc = `{
1810718107
"type": "object",
1810818108
"properties": {
1810918109
"enable_structure_type": {
18110-
"description": "@Description 是否启用结构化类型的重写",
18110+
"description": "是否启用结构化类型的重写",
1811118111
"type": "boolean",
1811218112
"default": false,
1811318113
"example": false
@@ -18118,7 +18118,7 @@ var doc = `{
1811818118
"type": "object",
1811918119
"properties": {
1812018120
"audit_level": {
18121-
"description": "@Description 审核规则等级\n@Required",
18121+
"description": "审核规则等级",
1812218122
"type": "string",
1812318123
"enum": [
1812418124
"normal",
@@ -18128,27 +18128,27 @@ var doc = `{
1812818128
]
1812918129
},
1813018130
"ddl_dcl": {
18131-
"description": "@Description 具体的数据库结构变更语句，需要在数据库中执行该变更语句之后再应用重写SQL（包含CREATE/ALTER/DROP等DDL语句，或SET等DCL语句）（适用于结构级重写）",
18131+
"description": "具体的数据库结构变更语句，需要在数据库中执行该变更语句之后再应用重写SQL（包含CREATE/ALTER/DROP等DDL语句，或SET等DCL语句）（适用于结构级重写）",
1813218132
"type": "string"
1813318133
},
1813418134
"ddl_dcl_desc": {
18135-
"description": "@Description 数据库结构变更建议说明（例如：建议添加索引、修改表结构等优化建议）（适用于结构级重写）",
18135+
"description": "数据库结构变更建议说明（例如：建议添加索引、修改表结构等优化建议）（适用于结构级重写）",
1813618136
"type": "string"
1813718137
},
1813818138
"desc": {
18139-
"description": "@Description 重写描述（适用于所有类型）\n@Required",
18139+
"description": "重写描述（适用于所有类型）",
1814018140
"type": "string"
1814118141
},
1814218142
"rewritten_sql": {
18143-
"description": "@Description 重写后的SQL（适用于语句级重写和结构级重写）",
18143+
"description": "重写后的SQL（适用于语句级重写和结构级重写）",
1814418144
"type": "string"
1814518145
},
1814618146
"rule_name": {
18147-
"description": "@Description 审核规则名称\n@Required",
18147+
"description": "审核规则名称",
1814818148
"type": "string"
1814918149
},
1815018150
"status": {
18151-
"description": "@Description 处理状态：初始化、已处理",
18151+
"description": "处理状态：初始化、已处理",
1815218152
"type": "string",
1815318153
"default": "initial",
1815418154
"enum": [
@@ -18157,7 +18157,7 @@ var doc = `{
1815718157
]
1815818158
},
1815918159
"type": {
18160-
"description": "@Description 重写建议类型：语句级重写、结构级重写、其他\n@Required",
18160+
"description": "重写建议类型：语句级重写、结构级重写、其他",
1816118161
"type": "string",
1816218162
"enum": [
1816318163
"statement",

‎sqle/docs/swagger.json‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -12495,28 +12495,28 @@
1249512495
"type": "object",
1249612496
"properties": {
1249712497
"end_time": {
12498-
"description": "@Description 结束时间",
12498+
"description": "结束时间",
1249912499
"type": "string"
1250012500
},
1250112501
"error_message": {
12502-
"description": "@Description 错误信息",
12502+
"description": "错误信息",
1250312503
"type": "string"
1250412504
},
1250512505
"result": {
12506-
"description": "@Description 重写结果",
12506+
"description": "重写结果",
1250712507
"type": "object",
1250812508
"$ref": "#/definitions/v1.RewriteSQLData"
1250912509
},
1251012510
"sql_number": {
12511-
"description": "@Description SQL编号",
12511+
"description": "SQL编号",
1251212512
"type": "string"
1251312513
},
1251412514
"start_time": {
12515-
"description": "@Description 开始时间",
12515+
"description": "开始时间",
1251612516
"type": "string"
1251712517
},
1251812518
"status": {
12519-
"description": "@Description 任务状态",
12519+
"description": "任务状态",
1252012520
"type": "string",
1252112521
"enum": [
1252212522
"pending",
@@ -12526,7 +12526,7 @@
1252612526
]
1252712527
},
1252812528
"task_id": {
12529-
"description": "@Description 任务ID",
12529+
"description": "任务ID",
1253012530
"type": "string"
1253112531
}
1253212532
}
@@ -18055,31 +18055,31 @@
1805518055
"type": "object",
1805618056
"properties": {
1805718057
"business_desc": {
18058-
"description": "@Description 重写前的SQL业务描述",
18058+
"description": "重写前的SQL业务描述",
1805918059
"type": "string"
1806018060
},
1806118061
"business_non_equivalent_desc": {
18062-
"description": "@Description 重写前后的业务不等价性描述，为空表示等价",
18062+
"description": "重写前后的业务不等价性描述，为空表示等价",
1806318063
"type": "string"
1806418064
},
1806518065
"logic_desc": {
18066-
"description": "@Description 重写前的SQL执行逻辑描述",
18066+
"description": "重写前的SQL执行逻辑描述",
1806718067
"type": "string"
1806818068
},
1806918069
"rewritten_sql": {
18070-
"description": "@Description 重写后的SQL",
18070+
"description": "重写后的SQL",
1807118071
"type": "string"
1807218072
},
1807318073
"rewritten_sql_business_desc": {
18074-
"description": "@Description 重写后的SQL业务描述",
18074+
"description": "重写后的SQL业务描述",
1807518075
"type": "string"
1807618076
},
1807718077
"rewritten_sql_logic_desc": {
18078-
"description": "@Description 重写后的SQL执行逻辑描述",
18078+
"description": "重写后的SQL执行逻辑描述",
1807918079
"type": "string"
1808018080
},
1808118081
"suggestions": {
18082-
"description": "@Description 重写建议列表",
18082+
"description": "重写建议列表",
1808318083
"type": "array",
1808418084
"items": {
1808518085
"$ref": "#/definitions/v1.RewriteSuggestion"
@@ -18091,7 +18091,7 @@
1809118091
"type": "object",
1809218092
"properties": {
1809318093
"enable_structure_type": {
18094-
"description": "@Description 是否启用结构化类型的重写",
18094+
"description": "是否启用结构化类型的重写",
1809518095
"type": "boolean",
1809618096
"default": false,
1809718097
"example": false
@@ -18102,7 +18102,7 @@
1810218102
"type": "object",
1810318103
"properties": {
1810418104
"audit_level": {
18105-
"description": "@Description 审核规则等级\n@Required",
18105+
"description": "审核规则等级",
1810618106
"type": "string",
1810718107
"enum": [
1810818108
"normal",
@@ -18112,27 +18112,27 @@
1811218112
]
1811318113
},
1811418114
"ddl_dcl": {
18115-
"description": "@Description 具体的数据库结构变更语句，需要在数据库中执行该变更语句之后再应用重写SQL（包含CREATE/ALTER/DROP等DDL语句，或SET等DCL语句）（适用于结构级重写）",
18115+
"description": "具体的数据库结构变更语句，需要在数据库中执行该变更语句之后再应用重写SQL（包含CREATE/ALTER/DROP等DDL语句，或SET等DCL语句）（适用于结构级重写）",
1811618116
"type": "string"
1811718117
},
1811818118
"ddl_dcl_desc": {
18119-
"description": "@Description 数据库结构变更建议说明（例如：建议添加索引、修改表结构等优化建议）（适用于结构级重写）",
18119+
"description": "数据库结构变更建议说明（例如：建议添加索引、修改表结构等优化建议）（适用于结构级重写）",
1812018120
"type": "string"
1812118121
},
1812218122
"desc": {
18123-
"description": "@Description 重写描述（适用于所有类型）\n@Required",
18123+
"description": "重写描述（适用于所有类型）",
1812418124
"type": "string"
1812518125
},
1812618126
"rewritten_sql": {
18127-
"description": "@Description 重写后的SQL（适用于语句级重写和结构级重写）",
18127+
"description": "重写后的SQL（适用于语句级重写和结构级重写）",
1812818128
"type": "string"
1812918129
},
1813018130
"rule_name": {
18131-
"description": "@Description 审核规则名称\n@Required",
18131+
"description": "审核规则名称",
1813218132
"type": "string"
1813318133
},
1813418134
"status": {
18135-
"description": "@Description 处理状态：初始化、已处理",
18135+
"description": "处理状态：初始化、已处理",
1813618136
"type": "string",
1813718137
"default": "initial",
1813818138
"enum": [
@@ -18141,7 +18141,7 @@
1814118141
]
1814218142
},
1814318143
"type": {
18144-
"description": "@Description 重写建议类型：语句级重写、结构级重写、其他\n@Required",
18144+
"description": "重写建议类型：语句级重写、结构级重写、其他",
1814518145
"type": "string",
1814618146
"enum": [
1814718147
"statement",

0 commit comments

Comments
 (0)