thomas/rustdesk-api
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

i18n: Translate all Chinese to English across the codebase

Browse Source 
Translate Chinese comments, log/error messages, validator labels and
Swagger annotations to English throughout the source code, generated
Swagger docs, config files and CI workflows.

Make the English README primary: README.md now holds the English docs
and README_EN.md holds the Chinese version, with cross-language links
updated accordingly.

Note: the generated docs/ swagger files were translated in place; run
`go generate ./...` (swag init) to regenerate them from the now-English
annotations when a Go toolchain is available.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
thomas
2026-06-27 12:17:04 +02:00
co-authored by Claude Opus 4.8
parent c5687e1506
commit 16e97c8efa
103 changed files with 3088 additions and 3086 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/admin/admin_docs.go
+428 -428
View File
File diff suppressed because it is too large Load Diff
docs/admin/admin_swagger.json
+428 -428
View File
File diff suppressed because it is too large Load Diff
docs/admin/admin_swagger.yaml
+429 -429
View File
File diff suppressed because it is too large Load Diff
docs/api/api_docs.go
+109 -109
View File
@@ -17,7 +17,7 @@ const docTemplateapi = `{
"paths": {
"/": {
"get": {
"description": "首页",
"description": "home",
"consumes": [
"application/json"
],
@@ -25,9 +25,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"首页"
"home"
],
"summary": "首页",
"summary": "home",
"responses": {
"200": {
"description": "OK",
@@ -51,7 +51,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "地址列表",
"description": "address list",
"consumes": [
"application/json"
],
@@ -59,9 +59,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址"
"address"
],
"summary": "地址列表",
"summary": "address list",
"responses": {
"200": {
"description": "OK",
@@ -83,7 +83,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "地址更新",
"description": "address update",
"consumes": [
"application/json"
],
@@ -91,12 +91,12 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址"
"address"
],
"summary": "地址更新",
"summary": "address update",
"parameters": [
{
"description": "地址表单",
"description": "address form",
"name": "body",
"in": "body",
"required": true,
@@ -128,7 +128,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "添加地址",
"description": "add address",
"consumes": [
"application/json"
],
@@ -136,9 +136,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "添加地址",
"summary": "add address",
"parameters": [
{
"type": "string",
@@ -169,7 +169,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "删除地址",
"description": "delete address",
"consumes": [
"application/json"
],
@@ -177,9 +177,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "删除地址",
"summary": "delete address",
"parameters": [
{
"type": "string",
@@ -212,7 +212,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "更新地址",
"description": "update address",
"consumes": [
"application/json"
],
@@ -220,9 +220,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "更新地址",
"summary": "update address",
"parameters": [
{
"type": "string",
@@ -255,7 +255,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "地址",
"description": "address",
"consumes": [
"application/json"
],
@@ -263,19 +263,19 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "地址列表",
"summary": "address list",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "current",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
@@ -309,7 +309,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "个人地址",
"description": "personal address",
"consumes": [
"application/json"
],
@@ -317,9 +317,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "个人地址",
"summary": "personal address",
"parameters": [
{
"description": "string valid",
@@ -353,7 +353,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "设置",
"description": "settings",
"consumes": [
"application/json"
],
@@ -361,9 +361,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "设置",
"summary": "settings",
"parameters": [
{
"description": "string valid",
@@ -397,7 +397,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "共享",
"description": "shared",
"consumes": [
"application/json"
],
@@ -405,19 +405,19 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "共享地址簿",
"summary": "shared address book",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "current",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
}
@@ -445,7 +445,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -453,9 +453,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签添加",
"summary": "add tag",
"parameters": [
{
"type": "string",
@@ -488,7 +488,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -496,9 +496,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签重命名",
"summary": "rename tag",
"parameters": [
{
"type": "string",
@@ -531,7 +531,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -539,9 +539,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签修改颜色",
"summary": "change tag color",
"parameters": [
{
"type": "string",
@@ -574,7 +574,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -582,9 +582,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签删除",
"summary": "delete tag",
"parameters": [
{
"type": "string",
@@ -617,7 +617,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -625,9 +625,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签",
"summary": "tag",
"parameters": [
{
"type": "string",
@@ -655,7 +655,7 @@ const docTemplateapi = `{
},
"/audit/conn": {
"post": {
"description": "审计连接",
"description": "audit connection",
"consumes": [
"application/json"
],
@@ -663,12 +663,12 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"审计"
"audit"
],
"summary": "审计连接",
"summary": "audit connection",
"parameters": [
{
"description": "审计连接",
"description": "audit connection",
"name": "body",
"in": "body",
"required": true,
@@ -695,7 +695,7 @@ const docTemplateapi = `{
},
"/audit/file": {
"post": {
"description": "审计文件",
"description": "audit file",
"consumes": [
"application/json"
],
@@ -703,12 +703,12 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"审计"
"audit"
],
"summary": "审计文件",
"summary": "audit file",
"parameters": [
{
"description": "审计文件",
"description": "audit file",
"name": "body",
"in": "body",
"required": true,
@@ -740,7 +740,7 @@ const docTemplateapi = `{
"token": []
}
],
"description": "用户信息",
"description": "user info",
"consumes": [
"application/json"
],
@@ -748,9 +748,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"用户"
"user"
],
"summary": "用户信息",
"summary": "user info",
"responses": {
"200": {
"description": "OK",
@@ -774,7 +774,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "机器",
"description": "machine",
"consumes": [
"application/json"
],
@@ -782,25 +782,25 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"群组"
"group"
],
"summary": "设备",
"summary": "device",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "状态",
"description": "status",
"name": "status",
"in": "query"
},
@@ -829,7 +829,7 @@ const docTemplateapi = `{
},
"/heartbeat": {
"post": {
"description": "心跳",
"description": "heartbeat",
"consumes": [
"application/json"
],
@@ -837,9 +837,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"首页"
"home"
],
"summary": "心跳",
"summary": "heartbeat",
"responses": {
"200": {
"description": "OK"
@@ -855,7 +855,7 @@ const docTemplateapi = `{
},
"/login": {
"post": {
"description": "登录",
"description": "login",
"consumes": [
"application/json"
],
@@ -863,12 +863,12 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"登录"
"login"
],
"summary": "登录",
"summary": "login",
"parameters": [
{
"description": "登录表单",
"description": "login form",
"name": "body",
"in": "body",
"required": true,
@@ -895,7 +895,7 @@ const docTemplateapi = `{
},
"/login-options": {
"get": {
"description": "登录选项",
"description": "login options",
"consumes": [
"application/json"
],
@@ -903,9 +903,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"登录"
"login"
],
"summary": "登录选项",
"summary": "login options",
"responses": {
"200": {
"description": "OK",
@@ -927,7 +927,7 @@ const docTemplateapi = `{
},
"/logout": {
"post": {
"description": "登出",
"description": "logout",
"consumes": [
"application/json"
],
@@ -935,9 +935,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"登录"
"login"
],
"summary": "登出",
"summary": "logout",
"responses": {
"200": {
"description": "OK",
@@ -1048,7 +1048,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "机器",
"description": "machine",
"consumes": [
"application/json"
],
@@ -1056,25 +1056,25 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"群组"
"group"
],
"summary": "机器",
"summary": "machine",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "状态",
"description": "status",
"name": "status",
"in": "query"
},
@@ -1108,7 +1108,7 @@ const docTemplateapi = `{
"token": []
}
],
"description": "服务配置,给webclient提供api-server",
"description": "service config, provides an api-server for the webclient",
"consumes": [
"application/json"
],
@@ -1118,7 +1118,7 @@ const docTemplateapi = `{
"tags": [
"WEBCLIENT"
],
"summary": "服务配置",
"summary": "service config",
"responses": {
"200": {
"description": "OK",
@@ -1142,7 +1142,7 @@ const docTemplateapi = `{
"token": []
}
],
"description": "服务配置,给webclient提供api-server",
"description": "service config, provides an api-server for the webclient",
"consumes": [
"application/json"
],
@@ -1152,7 +1152,7 @@ const docTemplateapi = `{
"tags": [
"WEBCLIENT_V2"
],
"summary": "服务配置",
"summary": "service config",
"responses": {
"200": {
"description": "OK",
@@ -1171,7 +1171,7 @@ const docTemplateapi = `{
},
"/shared-peer": {
"post": {
"description": "分享的peer",
"description": "shared peer",
"consumes": [
"application/json"
],
@@ -1181,7 +1181,7 @@ const docTemplateapi = `{
"tags": [
"WEBCLIENT"
],
"summary": "分享的peer",
"summary": "shared peer",
"responses": {
"200": {
"description": "OK",
@@ -1200,7 +1200,7 @@ const docTemplateapi = `{
},
"/sysinfo": {
"post": {
"description": "提交系统信息",
"description": "submit system info",
"consumes": [
"application/json"
],
@@ -1210,10 +1210,10 @@ const docTemplateapi = `{
"tags": [
"System"
],
"summary": "提交系统信息",
"summary": "submit system info",
"parameters": [
{
"description": "系统信息表单",
"description": "system info form",
"name": "body",
"in": "body",
"required": true,
@@ -1240,7 +1240,7 @@ const docTemplateapi = `{
},
"/sysinfo_ver": {
"post": {
"description": "获取系统版本信息",
"description": "get system version info",
"consumes": [
"application/json"
],
@@ -1250,7 +1250,7 @@ const docTemplateapi = `{
"tags": [
"System"
],
"summary": "获取系统版本信息",
"summary": "get system version info",
"responses": {
"200": {
"description": "OK",
@@ -1274,7 +1274,7 @@ const docTemplateapi = `{
"BearerAuth": []
}
],
"description": "用户列表",
"description": "user list",
"consumes": [
"application/json"
],
@@ -1282,25 +1282,25 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"群组"
"group"
],
"summary": "用户列表",
"summary": "user list",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "状态",
"description": "status",
"name": "status",
"in": "query"
},
@@ -1344,7 +1344,7 @@ const docTemplateapi = `{
},
"/version": {
"get": {
"description": "版本",
"description": "version",
"consumes": [
"application/json"
],
@@ -1352,9 +1352,9 @@ const docTemplateapi = `{
"application/json"
],
"tags": [
"首页"
"home"
],
"summary": "版本",
"summary": "version",
"responses": {
"200": {
"description": "OK",
@@ -1593,7 +1593,7 @@ const docTemplateapi = `{
"type": "integer"
},
"color": {
"description": "color 是flutter的颜色值,从0x00000000 到 0xFFFFFFFF; 前两位表示透明度，后面6位表示颜色, 可以转成rgba",
"description": "color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color, can be converted to rgba",
"type": "integer"
},
"created_at": {
@@ -1683,8 +1683,8 @@ var SwaggerInfoapi = &swag.Spec{
Host: "",
BasePath: "/api",
Schemes: []string{},
Title: "管理系统API",
Description: "接口",
Title: "management systemAPI",
Description: "API",
InfoInstanceName: "api",
SwaggerTemplate: docTemplateapi,
LeftDelim: "{{",
docs/api/api_swagger.json
+109 -109
View File
@@ -1,8 +1,8 @@
{
"swagger": "2.0",
"info": {
"description": "接口",
"title": "管理系统API",
"description": "API",
"title": "management systemAPI",
"contact": {},
"version": "1.0"
},
@@ -10,7 +10,7 @@
"paths": {
"/": {
"get": {
"description": "首页",
"description": "home",
"consumes": [
"application/json"
],
@@ -18,9 +18,9 @@
"application/json"
],
"tags": [
"首页"
"home"
],
"summary": "首页",
"summary": "home",
"responses": {
"200": {
"description": "OK",
@@ -44,7 +44,7 @@
"BearerAuth": []
}
],
"description": "地址列表",
"description": "address list",
"consumes": [
"application/json"
],
@@ -52,9 +52,9 @@
"application/json"
],
"tags": [
"地址"
"address"
],
"summary": "地址列表",
"summary": "address list",
"responses": {
"200": {
"description": "OK",
@@ -76,7 +76,7 @@
"BearerAuth": []
}
],
"description": "地址更新",
"description": "address update",
"consumes": [
"application/json"
],
@@ -84,12 +84,12 @@
"application/json"
],
"tags": [
"地址"
"address"
],
"summary": "地址更新",
"summary": "address update",
"parameters": [
{
"description": "地址表单",
"description": "address form",
"name": "body",
"in": "body",
"required": true,
@@ -121,7 +121,7 @@
"BearerAuth": []
}
],
"description": "添加地址",
"description": "add address",
"consumes": [
"application/json"
],
@@ -129,9 +129,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "添加地址",
"summary": "add address",
"parameters": [
{
"type": "string",
@@ -162,7 +162,7 @@
"BearerAuth": []
}
],
"description": "删除地址",
"description": "delete address",
"consumes": [
"application/json"
],
@@ -170,9 +170,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "删除地址",
"summary": "delete address",
"parameters": [
{
"type": "string",
@@ -205,7 +205,7 @@
"BearerAuth": []
}
],
"description": "更新地址",
"description": "update address",
"consumes": [
"application/json"
],
@@ -213,9 +213,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "更新地址",
"summary": "update address",
"parameters": [
{
"type": "string",
@@ -248,7 +248,7 @@
"BearerAuth": []
}
],
"description": "地址",
"description": "address",
"consumes": [
"application/json"
],
@@ -256,19 +256,19 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "地址列表",
"summary": "address list",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "current",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
@@ -302,7 +302,7 @@
"BearerAuth": []
}
],
"description": "个人地址",
"description": "personal address",
"consumes": [
"application/json"
],
@@ -310,9 +310,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "个人地址",
"summary": "personal address",
"parameters": [
{
"description": "string valid",
@@ -346,7 +346,7 @@
"BearerAuth": []
}
],
"description": "设置",
"description": "settings",
"consumes": [
"application/json"
],
@@ -354,9 +354,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "设置",
"summary": "settings",
"parameters": [
{
"description": "string valid",
@@ -390,7 +390,7 @@
"BearerAuth": []
}
],
"description": "共享",
"description": "shared",
"consumes": [
"application/json"
],
@@ -398,19 +398,19 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "共享地址簿",
"summary": "shared address book",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "current",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
}
@@ -438,7 +438,7 @@
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -446,9 +446,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签添加",
"summary": "add tag",
"parameters": [
{
"type": "string",
@@ -481,7 +481,7 @@
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -489,9 +489,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签重命名",
"summary": "rename tag",
"parameters": [
{
"type": "string",
@@ -524,7 +524,7 @@
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -532,9 +532,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签修改颜色",
"summary": "change tag color",
"parameters": [
{
"type": "string",
@@ -567,7 +567,7 @@
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -575,9 +575,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签删除",
"summary": "delete tag",
"parameters": [
{
"type": "string",
@@ -610,7 +610,7 @@
"BearerAuth": []
}
],
"description": "标签",
"description": "tag",
"consumes": [
"application/json"
],
@@ -618,9 +618,9 @@
"application/json"
],
"tags": [
"地址[Personal]"
"address[Personal]"
],
"summary": "标签",
"summary": "tag",
"parameters": [
{
"type": "string",
@@ -648,7 +648,7 @@
},
"/audit/conn": {
"post": {
"description": "审计连接",
"description": "audit connection",
"consumes": [
"application/json"
],
@@ -656,12 +656,12 @@
"application/json"
],
"tags": [
"审计"
"audit"
],
"summary": "审计连接",
"summary": "audit connection",
"parameters": [
{
"description": "审计连接",
"description": "audit connection",
"name": "body",
"in": "body",
"required": true,
@@ -688,7 +688,7 @@
},
"/audit/file": {
"post": {
"description": "审计文件",
"description": "audit file",
"consumes": [
"application/json"
],
@@ -696,12 +696,12 @@
"application/json"
],
"tags": [
"审计"
"audit"
],
"summary": "审计文件",
"summary": "audit file",
"parameters": [
{
"description": "审计文件",
"description": "audit file",
"name": "body",
"in": "body",
"required": true,
@@ -733,7 +733,7 @@
"token": []
}
],
"description": "用户信息",
"description": "user info",
"consumes": [
"application/json"
],
@@ -741,9 +741,9 @@
"application/json"
],
"tags": [
"用户"
"user"
],
"summary": "用户信息",
"summary": "user info",
"responses": {
"200": {
"description": "OK",
@@ -767,7 +767,7 @@
"BearerAuth": []
}
],
"description": "机器",
"description": "machine",
"consumes": [
"application/json"
],
@@ -775,25 +775,25 @@
"application/json"
],
"tags": [
"群组"
"group"
],
"summary": "设备",
"summary": "device",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "状态",
"description": "status",
"name": "status",
"in": "query"
},
@@ -822,7 +822,7 @@
},
"/heartbeat": {
"post": {
"description": "心跳",
"description": "heartbeat",
"consumes": [
"application/json"
],
@@ -830,9 +830,9 @@
"application/json"
],
"tags": [
"首页"
"home"
],
"summary": "心跳",
"summary": "heartbeat",
"responses": {
"200": {
"description": "OK"
@@ -848,7 +848,7 @@
},
"/login": {
"post": {
"description": "登录",
"description": "login",
"consumes": [
"application/json"
],
@@ -856,12 +856,12 @@
"application/json"
],
"tags": [
"登录"
"login"
],
"summary": "登录",
"summary": "login",
"parameters": [
{
"description": "登录表单",
"description": "login form",
"name": "body",
"in": "body",
"required": true,
@@ -888,7 +888,7 @@
},
"/login-options": {
"get": {
"description": "登录选项",
"description": "login options",
"consumes": [
"application/json"
],
@@ -896,9 +896,9 @@
"application/json"
],
"tags": [
"登录"
"login"
],
"summary": "登录选项",
"summary": "login options",
"responses": {
"200": {
"description": "OK",
@@ -920,7 +920,7 @@
},
"/logout": {
"post": {
"description": "登出",
"description": "logout",
"consumes": [
"application/json"
],
@@ -928,9 +928,9 @@
"application/json"
],
"tags": [
"登录"
"login"
],
"summary": "登出",
"summary": "logout",
"responses": {
"200": {
"description": "OK",
@@ -1041,7 +1041,7 @@
"BearerAuth": []
}
],
"description": "机器",
"description": "machine",
"consumes": [
"application/json"
],
@@ -1049,25 +1049,25 @@
"application/json"
],
"tags": [
"群组"
"group"
],
"summary": "机器",
"summary": "machine",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "状态",
"description": "status",
"name": "status",
"in": "query"
},
@@ -1101,7 +1101,7 @@
"token": []
}
],
"description": "服务配置,给webclient提供api-server",
"description": "service config, provides an api-server for the webclient",
"consumes": [
"application/json"
],
@@ -1111,7 +1111,7 @@
"tags": [
"WEBCLIENT"
],
"summary": "服务配置",
"summary": "service config",
"responses": {
"200": {
"description": "OK",
@@ -1135,7 +1135,7 @@
"token": []
}
],
"description": "服务配置,给webclient提供api-server",
"description": "service config, provides an api-server for the webclient",
"consumes": [
"application/json"
],
@@ -1145,7 +1145,7 @@
"tags": [
"WEBCLIENT_V2"
],
"summary": "服务配置",
"summary": "service config",
"responses": {
"200": {
"description": "OK",
@@ -1164,7 +1164,7 @@
},
"/shared-peer": {
"post": {
"description": "分享的peer",
"description": "shared peer",
"consumes": [
"application/json"
],
@@ -1174,7 +1174,7 @@
"tags": [
"WEBCLIENT"
],
"summary": "分享的peer",
"summary": "shared peer",
"responses": {
"200": {
"description": "OK",
@@ -1193,7 +1193,7 @@
},
"/sysinfo": {
"post": {
"description": "提交系统信息",
"description": "submit system info",
"consumes": [
"application/json"
],
@@ -1203,10 +1203,10 @@
"tags": [
"System"
],
"summary": "提交系统信息",
"summary": "submit system info",
"parameters": [
{
"description": "系统信息表单",
"description": "system info form",
"name": "body",
"in": "body",
"required": true,
@@ -1233,7 +1233,7 @@
},
"/sysinfo_ver": {
"post": {
"description": "获取系统版本信息",
"description": "get system version info",
"consumes": [
"application/json"
],
@@ -1243,7 +1243,7 @@
"tags": [
"System"
],
"summary": "获取系统版本信息",
"summary": "get system version info",
"responses": {
"200": {
"description": "OK",
@@ -1267,7 +1267,7 @@
"BearerAuth": []
}
],
"description": "用户列表",
"description": "user list",
"consumes": [
"application/json"
],
@@ -1275,25 +1275,25 @@
"application/json"
],
"tags": [
"群组"
"group"
],
"summary": "用户列表",
"summary": "user list",
"parameters": [
{
"type": "integer",
"description": "页码",
"description": "page number",
"name": "page",
"in": "query"
},
{
"type": "integer",
"description": "每页数量",
"description": "items per page",
"name": "pageSize",
"in": "query"
},
{
"type": "integer",
"description": "状态",
"description": "status",
"name": "status",
"in": "query"
},
@@ -1337,7 +1337,7 @@
},
"/version": {
"get": {
"description": "版本",
"description": "version",
"consumes": [
"application/json"
],
@@ -1345,9 +1345,9 @@
"application/json"
],
"tags": [
"首页"
"home"
],
"summary": "版本",
"summary": "version",
"responses": {
"200": {
"description": "OK",
@@ -1586,7 +1586,7 @@
"type": "integer"
},
"color": {
"description": "color 是flutter的颜色值,从0x00000000 到 0xFFFFFFFF; 前两位表示透明度，后面6位表示颜色, 可以转成rgba",
"description": "color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color, can be converted to rgba",
"type": "integer"
},
"created_at": {
docs/api/api_swagger.yaml
+110 -110
View File
@@ -146,8 +146,8 @@ definitions:
collection_id:
type: integer
color:
description: color 是flutter的颜色值,从0x00000000 到 0xFFFFFFFF; 前两位表示透明度，后面6位表示颜色,
可以转成rgba
description: color is flutter's color value,from 0x00000000 to 0xFFFFFFFF; the first two digits represent transparency, the following 6 digits represent the color,
can be converted to rgba
type: integer
created_at:
type: string
@@ -194,15 +194,15 @@ definitions:
type: object
info:
contact: {}
description: 接口
title: 管理系统API
description: API
title: management systemAPI
version: "1.0"
paths:
/:
get:
consumes:
- application/json
description: 首页
description: home
produces:
- application/json
responses:
@@ -214,14 +214,14 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: 首页
summary: home
tags:
- 首页
- home
/ab:
get:
consumes:
- application/json
description: 地址列表
description: address list
produces:
- application/json
responses:
@@ -235,15 +235,15 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 地址列表
summary: address list
tags:
- 地址
- address
post:
consumes:
- application/json
description: 地址更新
description: address update
parameters:
- description: 地址表单
- description: address form
in: body
name: body
required: true
@@ -262,14 +262,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 地址更新
summary: address update
tags:
- 地址
- address
/ab/peer/add/{guid}:
delete:
consumes:
- application/json
description: 删除地址
description: delete address
parameters:
- description: guid
in: path
@@ -289,13 +289,13 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 删除地址
summary: delete address
tags:
- 地址[Personal]
- address[Personal]
post:
consumes:
- application/json
description: 添加地址
description: add address
parameters:
- description: guid
in: path
@@ -315,14 +315,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 添加地址
summary: add address
tags:
- 地址[Personal]
- address[Personal]
/ab/peer/update/{guid}:
put:
consumes:
- application/json
description: 更新地址
description: update address
parameters:
- description: guid
in: path
@@ -342,20 +342,20 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 更新地址
summary: update address
tags:
- 地址[Personal]
- address[Personal]
/ab/peers:
post:
consumes:
- application/json
description: 地址
description: address
parameters:
- description: 页码
- description: page number
in: query
name: current
type: integer
- description: 每页数量
- description: items per page
in: query
name: pageSize
type: integer
@@ -376,14 +376,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- BearerAuth: []
summary: 地址列表
summary: address list
tags:
- 地址[Personal]
- address[Personal]
/ab/personal:
post:
consumes:
- application/json
description: 个人地址
description: personal address
parameters:
- description: string valid
in: body
@@ -403,14 +403,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- BearerAuth: []
summary: 个人地址
summary: personal address
tags:
- 地址[Personal]
- address[Personal]
/ab/settings:
post:
consumes:
- application/json
description: 设置
description: settings
parameters:
- description: string valid
in: body
@@ -430,20 +430,20 @@ paths:
$ref: '#/definitions/response.Response'
security:
- BearerAuth: []
summary: 设置
summary: settings
tags:
- 地址[Personal]
- address[Personal]
/ab/shared/profiles:
post:
consumes:
- application/json
description: 共享
description: shared
parameters:
- description: 页码
- description: page number
in: query
name: current
type: integer
- description: 每页数量
- description: items per page
in: query
name: pageSize
type: integer
@@ -460,14 +460,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- BearerAuth: []
summary: 共享地址簿
summary: shared address book
tags:
- 地址[Personal]
- address[Personal]
/ab/tag/{guid}:
delete:
consumes:
- application/json
description: 标签
description: tag
parameters:
- description: guid
in: path
@@ -487,14 +487,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 标签删除
summary: delete tag
tags:
- 地址[Personal]
- address[Personal]
/ab/tag/add/{guid}:
post:
consumes:
- application/json
description: 标签
description: tag
parameters:
- description: guid
in: path
@@ -514,14 +514,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 标签添加
summary: add tag
tags:
- 地址[Personal]
- address[Personal]
/ab/tag/rename/{guid}:
put:
consumes:
- application/json
description: 标签
description: tag
parameters:
- description: guid
in: path
@@ -541,14 +541,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 标签重命名
summary: rename tag
tags:
- 地址[Personal]
- address[Personal]
/ab/tag/update/{guid}:
put:
consumes:
- application/json
description: 标签
description: tag
parameters:
- description: guid
in: path
@@ -568,14 +568,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 标签修改颜色
summary: change tag color
tags:
- 地址[Personal]
- address[Personal]
/ab/tags/{guid}:
post:
consumes:
- application/json
description: 标签
description: tag
parameters:
- description: guid
in: path
@@ -595,16 +595,16 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 标签
summary: tag
tags:
- 地址[Personal]
- address[Personal]
/audit/conn:
post:
consumes:
- application/json
description: 审计连接
description: audit connection
parameters:
- description: 审计连接
- description: audit connection
in: body
name: body
required: true
@@ -621,16 +621,16 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: 审计连接
summary: audit connection
tags:
- 审计
- audit
/audit/file:
post:
consumes:
- application/json
description: 审计文件
description: audit file
parameters:
- description: 审计文件
- description: audit file
in: body
name: body
required: true
@@ -647,14 +647,14 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: 审计文件
summary: audit file
tags:
- 审计
- audit
/currentUser:
get:
consumes:
- application/json
description: 用户信息
description: user info
produces:
- application/json
responses:
@@ -668,24 +668,24 @@ paths:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: 用户信息
summary: user info
tags:
- 用户
- user
/device-group/accessible:
get:
consumes:
- application/json
description: 机器
description: machine
parameters:
- description: 页码
- description: page number
in: query
name: page
type: integer
- description: 每页数量
- description: items per page
in: query
name: pageSize
type: integer
- description: 状态
- description: status
in: query
name: status
type: integer
@@ -706,14 +706,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- BearerAuth: []
summary: 设备
summary: device
tags:
- 群组
- group
/heartbeat:
post:
consumes:
- application/json
description: 心跳
description: heartbeat
produces:
- application/json
responses:
@@ -723,16 +723,16 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: 心跳
summary: heartbeat
tags:
- 首页
- home
/login:
post:
consumes:
- application/json
description: 登录
description: login
parameters:
- description: 登录表单
- description: login form
in: body
name: body
required: true
@@ -749,14 +749,14 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.ErrorResponse'
summary: 登录
summary: login
tags:
- 登录
- login
/login-options:
get:
consumes:
- application/json
description: 登录选项
description: login options
produces:
- application/json
responses:
@@ -770,14 +770,14 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.ErrorResponse'
summary: 登录选项
summary: login options
tags:
- 登录
- login
/logout:
post:
consumes:
- application/json
description: 登出
description: logout
produces:
- application/json
responses:
@@ -789,9 +789,9 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.ErrorResponse'
summary: 登出
summary: logout
tags:
- 登录
- login
/oidc/auth:
post:
consumes:
@@ -853,17 +853,17 @@ paths:
get:
consumes:
- application/json
description: 机器
description: machine
parameters:
- description: 页码
- description: page number
in: query
name: page
type: integer
- description: 每页数量
- description: items per page
in: query
name: pageSize
type: integer
- description: 状态
- description: status
in: query
name: status
type: integer
@@ -884,14 +884,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- BearerAuth: []
summary: 机器
summary: machine
tags:
- 群组
- group
/server-config:
get:
consumes:
- application/json
description: 服务配置,给webclient提供api-server
description: service config, provides an api-server for the webclient
produces:
- application/json
responses:
@@ -905,14 +905,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: 服务配置
summary: service config
tags:
- WEBCLIENT
/server-config-v2:
get:
consumes:
- application/json
description: 服务配置,给webclient提供api-server
description: service config, provides an api-server for the webclient
produces:
- application/json
responses:
@@ -926,14 +926,14 @@ paths:
$ref: '#/definitions/response.Response'
security:
- token: []
summary: 服务配置
summary: service config
tags:
- WEBCLIENT_V2
/shared-peer:
post:
consumes:
- application/json
description: 分享的peer
description: shared peer
produces:
- application/json
responses:
@@ -945,16 +945,16 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: 分享的peer
summary: shared peer
tags:
- WEBCLIENT
/sysinfo:
post:
consumes:
- application/json
description: 提交系统信息
description: submit system info
parameters:
- description: 系统信息表单
- description: system info form
in: body
name: body
required: true
@@ -971,14 +971,14 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.ErrorResponse'
summary: 提交系统信息
summary: submit system info
tags:
- System
/sysinfo_ver:
post:
consumes:
- application/json
description: 获取系统版本信息
description: get system version info
produces:
- application/json
responses:
@@ -990,24 +990,24 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.ErrorResponse'
summary: 获取系统版本信息
summary: get system version info
tags:
- System
/users:
get:
consumes:
- application/json
description: 用户列表
description: user list
parameters:
- description: 页码
- description: page number
in: query
name: page
type: integer
- description: 每页数量
- description: items per page
in: query
name: pageSize
type: integer
- description: 状态
- description: status
in: query
name: status
type: integer
@@ -1035,14 +1035,14 @@ paths:
$ref: '#/definitions/response.ErrorResponse'
security:
- BearerAuth: []
summary: 用户列表
summary: user list
tags:
- 群组
- group
/version:
get:
consumes:
- application/json
description: 版本
description: version
produces:
- application/json
responses:
@@ -1054,9 +1054,9 @@ paths:
description: Internal Server Error
schema:
$ref: '#/definitions/response.Response'
summary: 版本
summary: version
tags:
- 首页
- home
securityDefinitions:
BearerAuth:
in: header