增加套餐相关API/给套餐相关API添加更多注释

This commit is contained in:
GoEdgeLab
2023-12-21 15:09:28 +08:00
parent c9bc1b07db
commit ad142856d0
6 changed files with 562 additions and 327 deletions

View File

@@ -3800,7 +3800,10 @@
"responseMessageName": "FindServerIdWithIPItemIdResponse",
"code": "rpc findServerIdWithIPItemId(FindServerIdWithIPItemIdRequest) returns (FindServerIdWithIPItemIdResponse);",
"doc": "查找IP对应的名单所属网站ID",
"roles": [],
"roles": [
"admin",
"user"
],
"isDeprecated": false
}
],
@@ -9508,6 +9511,17 @@
"responseMessageName": "ListEnabledPlansResponse",
"code": "rpc listEnabledPlans(ListEnabledPlansRequest) returns (ListEnabledPlansResponse);",
"doc": "列出单页套餐",
"roles": [
"admin"
],
"isDeprecated": false
},
{
"name": "findAllAvailablePlans",
"requestMessageName": "FindAllAvailablePlansRequest",
"responseMessageName": "FindAllAvailablePlansResponse",
"code": "rpc findAllAvailablePlans(FindAllAvailablePlansRequest) returns (FindAllAvailablePlansResponse);",
"doc": "列出所有可用的套餐",
"roles": [
"admin",
"user"
@@ -15543,7 +15557,7 @@
},
{
"name": "CreatePlanRequest",
"code": "message CreatePlanRequest {\n\tstring name = 1;\n\tint64 clusterId = 2;\n\tbytes trafficLimitJSON = 3;\n\tbool hasFullFeatures = 18; // 是否有所有权限\n\tbytes featuresJSON = 4; // 权限列表,[code1, code2, ...]\n\tstring priceType = 5;\n\tbytes trafficPriceJSON = 6;\n\tbytes bandwidthPriceJSON = 10;\n\tfloat monthlyPrice = 7; // 月度价格\n\tfloat seasonallyPrice = 8; // 季度价格\n\tfloat yearlyPrice = 9; // 年度价格\n\tint32 totalServers = 11; // 可以添加的网站数\n\tint32 totalServerNamesPerServer = 12; // 每个网站可以添加的域名数\n\tint32 totalServerNames = 13; // 可以添加的域名总数\n\tint64 dailyRequests = 14; // 每日访问量额度\n\tint64 monthlyRequests = 15; // 每月访问量额度\n\tint64 dailyWebsocketConnections = 16; // 每日Websocket连接数额度\n\tint64 monthlyWebsocketConnections = 17; // 每月Websocket连接数额度\n}",
"code": "message CreatePlanRequest {\n\tstring name = 1; // 套餐名称\n\tstring description = 19; // 套餐简介\n\tint64 clusterId = 2; // 集群ID\n\tbytes trafficLimitJSON = 3; // 流量限制\n\tbool hasFullFeatures = 18; // 是否有所有权限\n\tbytes featuresJSON = 4; // 权限列表,[code1, code2, ...]\n\tstring priceType = 5; // 价格类型traffic, bandwidth, period\n\tbytes trafficPriceJSON = 6; // 流量价格配置\n\tbytes bandwidthPriceJSON = 10; // 带宽价格配置\n\tfloat monthlyPrice = 7; // 月度价格\n\tfloat seasonallyPrice = 8; // 季度价格\n\tfloat yearlyPrice = 9; // 年度价格\n\tint32 totalServers = 11; // 可以添加的网站数\n\tint32 totalServerNamesPerServer = 12; // 每个网站可以添加的域名数\n\tint32 totalServerNames = 13; // 可以添加的域名总数\n\tint64 dailyRequests = 14; // 每日访问量额度\n\tint64 monthlyRequests = 15; // 每月访问量额度\n\tint64 dailyWebsocketConnections = 16; // 每日Websocket连接数额度\n\tint64 monthlyWebsocketConnections = 17; // 每月Websocket连接数额度\n}",
"doc": "创建套餐"
},
{
@@ -16143,7 +16157,7 @@
},
{
"name": "DeletePlanRequest",
"code": "message DeletePlanRequest {\n\tint64 planId = 1;\n}",
"code": "message DeletePlanRequest {\n\tint64 planId = 1; // 套餐ID\n}",
"doc": "删除套餐"
},
{
@@ -16686,6 +16700,16 @@
"code": "message FindAllAvailableOrderMethodsResponse {\n\trepeated OrderMethod orderMethods = 1;\n}",
"doc": ""
},
{
"name": "FindAllAvailablePlansRequest",
"code": "message FindAllAvailablePlansRequest {\n\n}",
"doc": "列出所有可用的套餐"
},
{
"name": "FindAllAvailablePlansResponse",
"code": "message FindAllAvailablePlansResponse {\n\trepeated Plan plans = 1; // 套餐列表\n}",
"doc": ""
},
{
"name": "FindAllAvailableTrafficPackagePeriodsRequest",
"code": "message FindAllAvailableTrafficPackagePeriodsRequest {\n\n}",
@@ -18388,12 +18412,12 @@
},
{
"name": "FindEnabledPlanRequest",
"code": "message FindEnabledPlanRequest {\n\tint64 planId = 1;\n}",
"code": "message FindEnabledPlanRequest {\n\tint64 planId = 1; // 套餐ID\n}",
"doc": "查找单个套餐"
},
{
"name": "FindEnabledPlanResponse",
"code": "message FindEnabledPlanResponse {\n\tPlan plan = 1;\n}",
"code": "message FindEnabledPlanResponse {\n\tPlan plan = 1; // 套餐信息\n}",
"doc": ""
},
{
@@ -20388,7 +20412,7 @@
},
{
"name": "ListEnabledPlansResponse",
"code": "message ListEnabledPlansResponse {\n\trepeated Plan plans = 1;\n}",
"code": "message ListEnabledPlansResponse {\n\trepeated Plan plans = 1; // 套餐列表\n}",
"doc": ""
},
{
@@ -21233,7 +21257,7 @@
},
{
"name": "Plan",
"code": "message Plan {\n\tint64 id = 1;\n\tbool isOn = 2;\n\tstring name = 3;\n\tint64 clusterId = 4;\n\tbytes trafficLimitJSON = 5;\n\tbool hasFullFeatures = 20; // 是否有所有权限\n\tbytes featuresJSON = 6; // 权限列表,[code1, code2, ...]\n\tstring priceType = 7;\n\tbytes trafficPriceJSON = 8;\n\tbytes bandwidthPriceJSON = 12;\n\tdouble monthlyPrice = 9;\n\tdouble seasonallyPrice = 10;\n\tdouble yearlyPrice = 11;\n\tint32 totalServers = 13; // 可以添加的网站数\n\tint32 totalServerNamesPerServer = 14; // 每个网站可以添加的域名数\n\tint32 totalServerNames = 15; // 可以添加的域名总数\n\tint64 dailyRequests = 16; // 每日访问量额度\n\tint64 monthlyRequests = 17; // 每月访问量额度\n\tint64 dailyWebsocketConnections = 18; // 每日Websocket连接数额度\n\tint64 monthlyWebsocketConnections = 19; // 每月Websocket连接数额度\n}",
"code": "message Plan {\n\tint64 id = 1; // 套餐ID\n\tbool isOn = 2; // 是否启用\n\tstring name = 3; // 套餐名称\n\tstring description = 21; // 套餐简介\n\tint64 clusterId = 4; // 集群ID\n\tbytes trafficLimitJSON = 5; // 流量限制\n\tbool hasFullFeatures = 20; // 是否有所有权限\n\tbytes featuresJSON = 6; // 权限列表,[code1, code2, ...]\n\tstring priceType = 7; // 价格类型traffic, bandwidth, period\n\tbytes trafficPriceJSON = 8; // 流量价格配置\n\tbytes bandwidthPriceJSON = 12; // 带宽价格配置\n\tdouble monthlyPrice = 9; // 月度价格\n\tdouble seasonallyPrice = 10; // 季度价格\n\tdouble yearlyPrice = 11; // 年度价格\n\tint32 totalServers = 13; // 可以添加的网站数\n\tint32 totalServerNamesPerServer = 14; // 每个网站可以添加的域名数\n\tint32 totalServerNames = 15; // 可以添加的域名总数\n\tint64 dailyRequests = 16; // 每日访问量额度\n\tint64 monthlyRequests = 17; // 每月访问量额度\n\tint64 dailyWebsocketConnections = 18; // 每日Websocket连接数额度\n\tint64 monthlyWebsocketConnections = 19; // 每月Websocket连接数额度\n}",
"doc": ""
},
{
@@ -21553,7 +21577,7 @@
},
{
"name": "SortPlansRequest",
"code": "message SortPlansRequest {\n\trepeated int64 planIds = 1;\n}",
"code": "message SortPlansRequest {\n\trepeated int64 planIds = 1; // 排序后的套餐ID列表\n}",
"doc": "对套餐进行排序"
},
{
@@ -22628,7 +22652,7 @@
},
{
"name": "UpdatePlanRequest",
"code": "message UpdatePlanRequest {\n\tint64 planId = 1;\n\tstring name = 2;\n\tbool isOn = 3;\n\tint64 clusterId = 4;\n\tbytes trafficLimitJSON = 5;\n\tbool hasFullFeatures = 20; // 是否有所有权限\n\tbytes featuresJSON = 6; // 权限列表,[code1, code2, ...]\n\tstring priceType = 7;\n\tbytes trafficPriceJSON = 8;\n\tbytes bandwidthPriceJSON = 12;\n\tfloat monthlyPrice = 9;\n\tfloat seasonallyPrice = 10;\n\tfloat yearlyPrice = 11;\n\tint32 totalServers = 13; // 可以添加的网站数\n\tint32 totalServerNamesPerServer = 14; // 每个网站可以添加的域名数\n\tint32 totalServerNames = 15; // 可以添加的域名总数\n\tint64 dailyRequests = 16; // 每日访问量额度\n\tint64 monthlyRequests = 17; // 每月访问量额度\n\tint64 dailyWebsocketConnections = 18; // 每日Websocket连接数额度\n\tint64 monthlyWebsocketConnections = 19; // 每月Websocket连接数额度\n}",
"code": "message UpdatePlanRequest {\n\tint64 planId = 1; // 套餐ID\n\tstring name = 2; // 套餐名称\n\tstring description = 21; // 套餐简介\n\tbool isOn = 3; // 是否启用\n\tint64 clusterId = 4; // 集群ID\n\tbytes trafficLimitJSON = 5; // 流量限制\n\tbool hasFullFeatures = 20; // 是否有所有权限\n\tbytes featuresJSON = 6; // 权限列表,[code1, code2, ...]\n\tstring priceType = 7; // 价格类型traffic, bandwidth, period\n\tbytes trafficPriceJSON = 8; // 流量价格配置\n\tbytes bandwidthPriceJSON = 12; // 带宽价格配置\n\tfloat monthlyPrice = 9; // 月费用\n\tfloat seasonallyPrice = 10; // 季度费用\n\tfloat yearlyPrice = 11; // 年度费用\n\tint32 totalServers = 13; // 可以添加的网站数\n\tint32 totalServerNamesPerServer = 14; // 每个网站可以添加的域名数\n\tint32 totalServerNames = 15; // 可以添加的域名总数\n\tint64 dailyRequests = 16; // 每日访问量额度\n\tint64 monthlyRequests = 17; // 每月访问量额度\n\tint64 dailyWebsocketConnections = 18; // 每日Websocket连接数额度\n\tint64 monthlyWebsocketConnections = 19; // 每月Websocket连接数额度\n}",
"doc": "修改套餐"
},
{