增加修改服务所在分组API/proto文件增加若干注释

This commit is contained in:
GoEdgeLab
2022-06-25 19:22:19 +08:00
parent be1a53e567
commit cd19ec5333
34 changed files with 4339 additions and 4166 deletions

View File

@@ -1,6 +1,9 @@
#!/usr/bin/env bash #!/usr/bin/env bash
echo "starting ..."
#rm -f ../pkg/rpc/pb/*.pb.go #rm -f ../pkg/rpc/pb/*.pb.go
protoc --go_out=plugins=grpc:../pkg/rpc --proto_path=../pkg/rpc/protos ../pkg/rpc/protos/*.proto protoc --go_out=plugins=grpc:../pkg/rpc --proto_path=../pkg/rpc/protos ../pkg/rpc/protos/*.proto
RESULT=$? RESULT=$?
if [ "${RESULT}" != "0" ]; then if [ "${RESULT}" != "0" ]; then

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@@ -8,6 +8,7 @@ import "models/model_admin_list.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "service_server_stat_board.proto"; import "service_server_stat_board.proto";
// 管理员服务
service AdminService { service AdminService {
// 登录 // 登录
rpc loginAdmin (LoginAdminRequest) returns (LoginAdminResponse); rpc loginAdmin (LoginAdminRequest) returns (LoginAdminResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/model_api_node.proto"; import "models/model_api_node.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// API节点服务
service APINodeService { service APINodeService {
// 创建API节点 // 创建API节点
rpc createAPINode (CreateAPINodeRequest) returns (CreateAPINodeResponse); rpc createAPINode (CreateAPINodeRequest) returns (CreateAPINodeResponse);

View File

@@ -7,6 +7,7 @@ import "models/model_db_node.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_db_table.proto"; import "models/model_db_table.proto";
// 数据库节点服务
service DBNodeService { service DBNodeService {
// 创建数据库节点 // 创建数据库节点
rpc createDBNode (CreateDBNodeRequest) returns (CreateDBNodeResponse); rpc createDBNode (CreateDBNodeRequest) returns (CreateDBNodeResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/model_dns_issue.proto"; import "models/model_dns_issue.proto";
// 域名解析服务
service DNSService { service DNSService {
// 查找问题 // 查找问题
rpc findAllDNSIssues (FindAllDNSIssuesRequest) returns (FindAllDNSIssuesResponse); rpc findAllDNSIssues (FindAllDNSIssuesRequest) returns (FindAllDNSIssuesResponse);

View File

@@ -7,6 +7,7 @@ import "models/model_http_access_log_policy.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_http_access_log.proto"; import "models/model_http_access_log.proto";
// 访问日志策略服务
service HTTPAccessLogPolicyService { service HTTPAccessLogPolicyService {
// 计算访问日志策略数量 // 计算访问日志策略数量
rpc countAllEnabledHTTPAccessLogPolicies (CountAllEnabledHTTPAccessLogPoliciesRequest) returns (RPCCountResponse); rpc countAllEnabledHTTPAccessLogPolicies (CountAllEnabledHTTPAccessLogPoliciesRequest) returns (RPCCountResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/model_http_cache_policy.proto"; import "models/model_http_cache_policy.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 缓存策略服务
service HTTPCachePolicyService { service HTTPCachePolicyService {
// 获取所有可用策略 // 获取所有可用策略
rpc findAllEnabledHTTPCachePolicies (FindAllEnabledHTTPCachePoliciesRequest) returns (FindAllEnabledHTTPCachePoliciesResponse); rpc findAllEnabledHTTPCachePolicies (FindAllEnabledHTTPCachePoliciesRequest) returns (FindAllEnabledHTTPCachePoliciesResponse);

View File

@@ -10,6 +10,7 @@ import "models/model_region_country.proto";
import "models/model_region_province.proto"; import "models/model_region_province.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// HTTP防火墙WAF服务
service HTTPFirewallPolicyService { service HTTPFirewallPolicyService {
// 获取所有可用策略 // 获取所有可用策略
rpc findAllEnabledHTTPFirewallPolicies (FindAllEnabledHTTPFirewallPoliciesRequest) returns (FindAllEnabledHTTPFirewallPoliciesResponse); rpc findAllEnabledHTTPFirewallPolicies (FindAllEnabledHTTPFirewallPoliciesRequest) returns (FindAllEnabledHTTPFirewallPoliciesResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_http_firewall_rule_group.proto"; import "models/model_http_firewall_rule_group.proto";
// WAF分组服务
service HTTPFirewallRuleGroupService { service HTTPFirewallRuleGroupService {
// 设置是否启用分组 // 设置是否启用分组
rpc updateHTTPFirewallRuleGroupIsOn (UpdateHTTPFirewallRuleGroupIsOnRequest) returns (RPCSuccess); rpc updateHTTPFirewallRuleGroupIsOn (UpdateHTTPFirewallRuleGroupIsOnRequest) returns (RPCSuccess);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_http_firewall_rule_set.proto"; import "models/model_http_firewall_rule_set.proto";
// WAF规则集服务
service HTTPFirewallRuleSetService { service HTTPFirewallRuleSetService {
// 根据配置创建或修改规则集 // 根据配置创建或修改规则集
rpc createOrUpdateHTTPFirewallRuleSetFromConfig (CreateOrUpdateHTTPFirewallRuleSetFromConfigRequest) returns (CreateOrUpdateHTTPFirewallRuleSetFromConfigResponse); rpc createOrUpdateHTTPFirewallRuleSetFromConfig (CreateOrUpdateHTTPFirewallRuleSetFromConfigRequest) returns (CreateOrUpdateHTTPFirewallRuleSetFromConfigResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/model_size_capacity.proto"; import "models/model_size_capacity.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// Gzip服务
service HTTPGzipService { service HTTPGzipService {
// 创建Gzip配置 // 创建Gzip配置
rpc createHTTPGzip (CreateHTTPGzipRequest) returns (CreateHTTPGzipResponse); rpc createHTTPGzip (CreateHTTPGzipRequest) returns (CreateHTTPGzipResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// HTTP Header管理服务
service HTTPHeaderService { service HTTPHeaderService {
// 创建Header // 创建Header
rpc createHTTPHeader (CreateHTTPHeaderRequest) returns (CreateHTTPHeaderResponse); rpc createHTTPHeader (CreateHTTPHeaderRequest) returns (CreateHTTPHeaderResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// HTTP Header策略服务
service HTTPHeaderPolicyService { service HTTPHeaderPolicyService {
// 查找策略配置 // 查找策略配置
rpc findEnabledHTTPHeaderPolicyConfig (FindEnabledHTTPHeaderPolicyConfigRequest) returns (FindEnabledHTTPHeaderPolicyConfigResponse); rpc findEnabledHTTPHeaderPolicyConfig (FindEnabledHTTPHeaderPolicyConfigRequest) returns (FindEnabledHTTPHeaderPolicyConfigResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 路由规则服务
service HTTPLocationService { service HTTPLocationService {
// 创建路径规则 // 创建路径规则
rpc createHTTPLocation (CreateHTTPLocationRequest) returns (CreateHTTPLocationResponse); rpc createHTTPLocation (CreateHTTPLocationRequest) returns (CreateHTTPLocationResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 自定义页面服务
service HTTPPageService { service HTTPPageService {
// 创建Page // 创建Page
rpc createHTTPPage (CreateHTTPPageRequest) returns (CreateHTTPPageResponse); rpc createHTTPPage (CreateHTTPPageRequest) returns (CreateHTTPPageResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 重写规则服务
service HTTPRewriteRuleService { service HTTPRewriteRuleService {
// 创建重写规则 // 创建重写规则
rpc createHTTPRewriteRule (CreateHTTPRewriteRuleRequest) returns (CreateHTTPRewriteRuleResponse); rpc createHTTPRewriteRule (CreateHTTPRewriteRuleRequest) returns (CreateHTTPRewriteRuleResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/model_http_web.proto"; import "models/model_http_web.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// HTTP Web相关管理服务
service HTTPWebService { service HTTPWebService {
// 创建Web配置 // 创建Web配置
rpc createHTTPWeb (CreateHTTPWebRequest) returns (CreateHTTPWebResponse); rpc createHTTPWeb (CreateHTTPWebRequest) returns (CreateHTTPWebResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// HTTP Websocket管理服务
service HTTPWebsocketService { service HTTPWebsocketService {
// 创建Websocket配置 // 创建Websocket配置
rpc createHTTPWebsocket (CreateHTTPWebsocketRequest) returns (CreateHTTPWebsocketResponse); rpc createHTTPWebsocket (CreateHTTPWebsocketRequest) returns (CreateHTTPWebsocketResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_log.proto"; import "models/model_log.proto";
// 审计日志服务
service LogService { service LogService {
// 创建日志 // 创建日志
rpc createLog (CreateLogRequest) returns (CreateLogResponse); rpc createLog (CreateLogRequest) returns (CreateLogResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/model_monitor_node.proto"; import "models/model_monitor_node.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 监控节点管理服务
service MonitorNodeService { service MonitorNodeService {
// 创建监控节点 // 创建监控节点
rpc createMonitorNode (CreateMonitorNodeRequest) returns (CreateMonitorNodeResponse); rpc createMonitorNode (CreateMonitorNodeRequest) returns (CreateMonitorNodeResponse);

View File

@@ -10,6 +10,7 @@ import "models/model_dns_route.proto";
import "models/model_size_capacity.proto"; import "models/model_size_capacity.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 边缘节点管理服务
service NodeService { service NodeService {
// 创建节点 // 创建节点
rpc createNode (CreateNodeRequest) returns (CreateNodeResponse); rpc createNode (CreateNodeRequest) returns (CreateNodeResponse);

View File

@@ -10,6 +10,7 @@ import "models/rpc_messages.proto";
import "models/model_dns_domain.proto"; import "models/model_dns_domain.proto";
import "models/model_dns_provider.proto"; import "models/model_dns_provider.proto";
// 边缘节点集群管理服务
service NodeClusterService { service NodeClusterService {
// 创建集群 // 创建集群
rpc createNodeCluster (CreateNodeClusterRequest) returns (CreateNodeClusterResponse); rpc createNodeCluster (CreateNodeClusterRequest) returns (CreateNodeClusterResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/model_node_grant.proto"; import "models/model_node_grant.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 节点认证信息管理服务
service NodeGrantService { service NodeGrantService {
// 创建认证 // 创建认证
rpc createNodeGrant (CreateNodeGrantRequest) returns (CreateNodeGrantResponse); rpc createNodeGrant (CreateNodeGrantRequest) returns (CreateNodeGrantResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/model_node_ip_address.proto"; import "models/model_node_ip_address.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 节点IP地址服务
service NodeIPAddressService { service NodeIPAddressService {
// 创建IP地址 // 创建IP地址
rpc createNodeIPAddress (CreateNodeIPAddressRequest) returns (CreateNodeIPAddressResponse); rpc createNodeIPAddress (CreateNodeIPAddressRequest) returns (CreateNodeIPAddressResponse);

View File

@@ -7,6 +7,7 @@ import "models/model_origin.proto";
import "models/model_network_address.proto"; import "models/model_network_address.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 源站管理服务
service OriginService { service OriginService {
// 创建源站 // 创建源站
rpc createOrigin (CreateOriginRequest) returns (CreateOriginResponse); rpc createOrigin (CreateOriginRequest) returns (CreateOriginResponse);

View File

@@ -6,6 +6,7 @@ package pb;
import "models/model_reverse_proxy.proto"; import "models/model_reverse_proxy.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 反向代理管理服务
service ReverseProxyService { service ReverseProxyService {
// 创建反向代理 // 创建反向代理
rpc createReverseProxy (CreateReverseProxyRequest) returns (CreateReverseProxyResponse); rpc createReverseProxy (CreateReverseProxyRequest) returns (CreateReverseProxyResponse);

View File

@@ -16,6 +16,9 @@ service ServerService {
// 修改服务基本信息 // 修改服务基本信息
rpc updateServerBasic (UpdateServerBasicRequest) returns (RPCSuccess); rpc updateServerBasic (UpdateServerBasicRequest) returns (RPCSuccess);
// 修改服务所在分组
rpc updateServerGroupIds(UpdateServerGroupIdsRequest) returns (RPCSuccess);
// 修改服务是否启用 // 修改服务是否启用
rpc updateServerIsOn (UpdateServerIsOnRequest) returns (RPCSuccess); rpc updateServerIsOn (UpdateServerIsOnRequest) returns (RPCSuccess);
@@ -194,6 +197,12 @@ message UpdateServerBasicRequest {
repeated int64 serverGroupIds = 6; repeated int64 serverGroupIds = 6;
} }
// 修改服务所在分组
message UpdateServerGroupIdsRequest {
int64 serverId = 1;
repeated int64 serverGroupIds = 2;
}
// 修改服务启是否启用 // 修改服务启是否启用
message UpdateServerIsOnRequest { message UpdateServerIsOnRequest {
int64 serverId = 1; int64 serverId = 1;

View File

@@ -6,6 +6,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_ssl_cert.proto"; import "models/model_ssl_cert.proto";
// SSL证书管理服务
service SSLCertService { service SSLCertService {
// 创建Cert // 创建Cert
rpc createSSLCert (CreateSSLCertRequest) returns (CreateSSLCertResponse); rpc createSSLCert (CreateSSLCertRequest) returns (CreateSSLCertResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// SSL/TLS策略管理服务
service SSLPolicyService { service SSLPolicyService {
// 创建Policy // 创建Policy
rpc createSSLPolicy (CreateSSLPolicyRequest) returns (CreateSSLPolicyResponse); rpc createSSLPolicy (CreateSSLPolicyRequest) returns (CreateSSLPolicyResponse);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 系统设置管理服务
service SysSettingService { service SysSettingService {
// 更改配置 // 更改配置
rpc updateSysSetting (UpdateSysSettingRequest) returns (RPCSuccess); rpc updateSysSetting (UpdateSysSettingRequest) returns (RPCSuccess);

View File

@@ -5,6 +5,7 @@ package pb;
import "models/model_user_node.proto"; import "models/model_user_node.proto";
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
// 用户节点管理服务
service UserNodeService { service UserNodeService {
// 创建用户节点 // 创建用户节点
rpc createUserNode (CreateUserNodeRequest) returns (CreateUserNodeResponse); rpc createUserNode (CreateUserNodeRequest) returns (CreateUserNodeResponse);

View File

@@ -6,7 +6,7 @@ package pb;
import "models/rpc_messages.proto"; import "models/rpc_messages.proto";
import "models/model_user_plan.proto"; import "models/model_user_plan.proto";
// 用户购买的套餐 // 用户购买的套餐管理服务
service UserPlanService { service UserPlanService {
// 购买套餐 // 购买套餐
rpc buyUserPlan(BuyUserPlanRequest) returns (BuyUserPlanResponse); rpc buyUserPlan(BuyUserPlanRequest) returns (BuyUserPlanResponse);