优化API命名

This commit is contained in:
GoEdgeLab
2021-11-24 12:01:00 +08:00
parent 2df33c07aa
commit 2c19d8405a
8 changed files with 712 additions and 552 deletions

View File

@@ -43,12 +43,12 @@ message CreateAuthorityNodeRequest {
}
message CreateAuthorityNodeResponse {
int64 nodeId = 1;
int64 authorityNodeId = 1;
}
// 修改认证节点
message UpdateAuthorityNodeRequest {
int64 nodeId = 1;
int64 authorityNodeId = 1;
string name = 2;
string description = 3;
bool isOn = 4;
@@ -56,7 +56,7 @@ message UpdateAuthorityNodeRequest {
// 删除认证节点
message DeleteAuthorityNodeRequest {
int64 nodeId = 1;
int64 authorityNodeId = 1;
}
// 列出所有可用认证节点
@@ -65,7 +65,7 @@ message FindAllEnabledAuthorityNodesRequest {
}
message FindAllEnabledAuthorityNodesResponse {
repeated AuthorityNode nodes = 1;
repeated AuthorityNode authorityNodes = 1;
}
// 计算认证节点数量
@@ -80,16 +80,16 @@ message ListEnabledAuthorityNodesRequest {
}
message ListEnabledAuthorityNodesResponse {
repeated AuthorityNode nodes = 1;
repeated AuthorityNode authorityNodes = 1;
}
// 根据ID查找节点
message FindEnabledAuthorityNodeRequest {
int64 nodeId = 1;
int64 authorityNodeId = 1;
}
message FindEnabledAuthorityNodeResponse {
AuthorityNode node = 1;
AuthorityNode authorityNode = 1;
}
// 获取当前认证节点
@@ -98,11 +98,11 @@ message FindCurrentAuthorityNodeRequest {
}
message FindCurrentAuthorityNodeResponse {
AuthorityNode node = 1;
AuthorityNode authorityNode = 1;
}
// 更新认证状态
message UpdateAuthorityNodeStatusRequest {
int64 nodeId = 1;
int64 authorityNodeId = 1;
bytes statusJSON = 2;
}

View File

@@ -78,6 +78,9 @@ service HTTPWebService {
// 更改认证设置
rpc updateHTTPWebAuth (UpdateHTTPWebAuthRequest) returns (RPCSuccess);
// 更改通用设置
rpc updateHTTPWebCommon(UpdateHTTPWebCommonRequest) returns (RPCSuccess);
}
// 创建Web配置
@@ -86,144 +89,144 @@ message CreateHTTPWebRequest {
}
message CreateHTTPWebResponse {
int64 webId = 1;
int64 httpWebId = 1;
}
// 查找Web信息
message FindEnabledHTTPWebRequest {
int64 webId = 1;
int64 httpWebId = 1;
}
message FindEnabledHTTPWebResponse {
HTTPWeb web = 1;
HTTPWeb httpWeb = 1;
}
// 查找Web配置
message FindEnabledHTTPWebConfigRequest {
int64 webId = 1;
int64 httpWebId = 1;
}
message FindEnabledHTTPWebConfigResponse {
bytes webJSON = 1;
bytes httpWebJSON = 1;
}
// 更改Web配置
message UpdateHTTPWebRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes rootJSON = 2;
}
// 更改压缩配置
message UpdateHTTPWebCompressionRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes compressionJSON = 2;
}
// 更改WebP配置
message UpdateHTTPWebWebPRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes webpJSON = 2;
}
// 更改RemoteAddr配置
message UpdateHTTPWebRemoteAddrRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes remoteAddrJSON = 2;
}
// 更改字符集配置
message UpdateHTTPWebCharsetRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes charsetJSON = 2;
}
// 更改请求Header策略
message UpdateHTTPWebRequestHeaderRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes headerJSON = 2;
}
// 更改响应Header策略
message UpdateHTTPWebResponseHeaderRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes headerJSON = 2;
}
// 更改Shutdown
message UpdateHTTPWebShutdownRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes shutdownJSON = 2;
}
// 更改Pages
message UpdateHTTPWebPagesRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes pagesJSON = 2;
}
// 更改访问日志配置
message UpdateHTTPWebAccessLogRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes accessLogJSON = 2;
}
// 更改统计配置
message UpdateHTTPWebStatRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes statJSON = 2;
}
// 更改缓存配置
message UpdateHTTPWebCacheRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes cacheJSON = 2;
}
// 更改防火墙设置
message UpdateHTTPWebFirewallRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes firewallJSON = 2;
}
// 更改路径规则配置
message UpdateHTTPWebLocationsRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes locationsJSON = 3;
}
// 更改跳转到HTTPS设置
message UpdateHTTPWebRedirectToHTTPSRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes redirectToHTTPSJSON = 2;
}
// 更改Websocket设置
message UpdateHTTPWebWebsocketRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes websocketJSON = 2;
}
// 更改Fastcgi设置
message UpdateHTTPWebFastcgiRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes fastcgiJSON = 2;
}
// 更改重写规则设置
message UpdateHTTPWebRewriteRulesRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes rewriteRulesJSON = 2;
}
// 更改主机跳转设置
message UpdateHTTPWebHostRedirectsRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes hostRedirectsJSON = 2;
}
// 查找主机跳转设置
message FindHTTPWebHostRedirectsRequest {
int64 webId = 1;
int64 httpWebId = 1;
}
message FindHTTPWebHostRedirectsResponse {
@@ -232,6 +235,12 @@ message FindHTTPWebHostRedirectsResponse {
// 更改认证设置
message UpdateHTTPWebAuthRequest {
int64 webId = 1;
int64 httpWebId = 1;
bytes authJSON = 2;
}
// 更改通用设置
message UpdateHTTPWebCommonRequest {
int64 httpWebId = 1;
bool mergeSlashes = 2;
}

View File

@@ -42,12 +42,12 @@ message CreateMonitorNodeRequest {
}
message CreateMonitorNodeResponse {
int64 nodeId = 1;
int64 monitorNodeId = 1;
}
// 修改监控节点
message UpdateMonitorNodeRequest {
int64 nodeId = 1;
int64 monitorNodeId = 1;
string name = 2;
string description = 3;
bool isOn = 4;
@@ -55,7 +55,7 @@ message UpdateMonitorNodeRequest {
// 删除监控节点
message DeleteMonitorNodeRequest {
int64 nodeId = 1;
int64 monitorNodeId = 1;
}
// 列出所有可用监控节点
@@ -64,7 +64,7 @@ message FindAllEnabledMonitorNodesRequest {
}
message FindAllEnabledMonitorNodesResponse {
repeated MonitorNode nodes = 1;
repeated MonitorNode monitorNodes = 1;
}
// 计算监控节点数量
@@ -79,16 +79,16 @@ message ListEnabledMonitorNodesRequest {
}
message ListEnabledMonitorNodesResponse {
repeated MonitorNode nodes = 1;
repeated MonitorNode monitorNodes = 1;
}
// 根据ID查找节点
message FindEnabledMonitorNodeRequest {
int64 nodeId = 1;
int64 monitorNodeId = 1;
}
message FindEnabledMonitorNodeResponse {
MonitorNode node = 1;
MonitorNode monitorNode = 1;
}
// 获取当前监控节点
@@ -97,11 +97,11 @@ message FindCurrentMonitorNodeRequest {
}
message FindCurrentMonitorNodeResponse {
MonitorNode node = 1;
MonitorNode monitorNode = 1;
}
// 更新监控状态
message UpdateMonitorNodeStatusRequest {
int64 nodeId = 1;
int64 monitorNodeId = 1;
bytes statusJSON = 2;
}