TRKJ/EdgeCommon
2
0
Fork 0
mirror of https://github.com/TeaOSLab/EdgeCommon.git synced 2025-11-16 06:40:26 +08:00
Code Issues Packages Projects Releases Wiki Activity

增加一些API注释

Browse Source
This commit is contained in:
GoEdgeLab
2023-08-06 19:33:45 +08:00
parent b7704886db
commit d80b7ffc36
3 changed files with 32 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
build/rpc.json
View File

@@ -14814,12 +14814,12 @@
}, },
{ {
"name": "CreateHTTPCacheTaskRequest", "name": "CreateHTTPCacheTaskRequest",
"code": "message CreateHTTPCacheTaskRequest {\n\tstring type = 1; // 类型：清理：purge，预热：fetch\n\tstring keyType = 2; // Key类型：单个URL：key，目录：prefix；预热的时候只能为 key\n\trepeated string keys = 3; // 要清理的Key\n}", "code": "message CreateHTTPCacheTaskRequest {\n\tstring type = 1; // 任务类型，值为 purge 或者 fetch；purge：删除缓存，fetch：预热缓存\n\tstring keyType = 2; // Key类型，值为 key 或者 prefix；如果是 key 表示处理的是URL，如果是 prefix 表示处理的是目录；预热的时候只能为 key\n\trepeated string keys = 3; // 要清理的Key，根据Key类型（keyType）来输入不同的内容\n}",
"doc": "创建任务" "doc": "创建任务"
}, },
{ {
"name": "CreateHTTPCacheTaskResponse", "name": "CreateHTTPCacheTaskResponse",
"code": "message CreateHTTPCacheTaskResponse {\n\tint64 httpCacheTaskId = 1;\n\tint64 countKeys = 2;\n}", "code": "message CreateHTTPCacheTaskResponse {\n\tint64 httpCacheTaskId = 1; // 生成的任务ID\n\tint64 countKeys = 2; // 任务中包含的Key\n}",
"doc": "" "doc": ""
}, },
{ {
@@ -15759,7 +15759,7 @@
}, },
{ {
"name": "DeleteHTTPCacheTaskRequest", "name": "DeleteHTTPCacheTaskRequest",
"code": "message DeleteHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1;\n}", "code": "message DeleteHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1; // 任务ID\n}",
"doc": "删除任务" "doc": "删除任务"
}, },
{ {
@@ -17759,12 +17759,12 @@
}, },
{ {
"name": "FindEnabledHTTPCacheTaskRequest", "name": "FindEnabledHTTPCacheTaskRequest",
"code": "message FindEnabledHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1;\n}", "code": "message FindEnabledHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1; // 任务ID\n}",
"doc": "查找单个任务" "doc": "查找单个任务"
}, },
{ {
"name": "FindEnabledHTTPCacheTaskResponse", "name": "FindEnabledHTTPCacheTaskResponse",
"code": "message FindEnabledHTTPCacheTaskResponse {\n\tHTTPCacheTask httpCacheTask = 1;\n}", "code": "message FindEnabledHTTPCacheTaskResponse {\n\tHTTPCacheTask httpCacheTask = 1; // 任务信息\n}",
"doc": "" "doc": ""
}, },
{ {
@@ -20289,12 +20289,12 @@
}, },
{ {
"name": "ListHTTPCacheTasksRequest", "name": "ListHTTPCacheTasksRequest",
"code": "message ListHTTPCacheTasksRequest {\n\tint64 offset = 1;\n\tint64 size = 2;\n}", "code": "message ListHTTPCacheTasksRequest {\n\tint64 offset = 1; // 查询起始位置\n\tint64 size = 2; // 查询条数\n}",
"doc": "列出单页任务" "doc": "列出单页任务"
}, },
{ {
"name": "ListHTTPCacheTasksResponse", "name": "ListHTTPCacheTasksResponse",
"code": "message ListHTTPCacheTasksResponse {\n\trepeated HTTPCacheTask httpCacheTasks = 1;\n}", "code": "message ListHTTPCacheTasksResponse {\n\trepeated HTTPCacheTask httpCacheTasks = 1; // 一组任务信息\n}",
"doc": "" "doc": ""
}, },
{ {
@@ -21184,7 +21184,7 @@
}, },
{ {
"name": "ResetHTTPCacheTaskRequest", "name": "ResetHTTPCacheTaskRequest",
"code": "message ResetHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1;\n}", "code": "message ResetHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1; // 任务ID\n}",
"doc": "重置任务状态" "doc": "重置任务状态"
}, },
{ {

24
pkg/rpc/pb/service_http_cache_task.pb.go
View File

@@ -35,9 +35,9 @@ type CreateHTTPCacheTaskRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // 类型：清理：purge，预热：fetch Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` // 任务类型，值为 purge 或者 fetch；purge：删除缓存，fetch：预热缓存
KeyType string `protobuf:"bytes,2,opt,name=keyType,proto3" json:"keyType,omitempty"` // Key类型：单个URL：key，目录：prefix；预热的时候只能为 key KeyType string `protobuf:"bytes,2,opt,name=keyType,proto3" json:"keyType,omitempty"` // Key类型，值为 key 或者 prefix；如果是 key 表示处理的是URL，如果是 prefix 表示处理的是目录；预热的时候只能为 key
Keys []string `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"` // 要清理的Key Keys []string `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"` // 要清理的Key，根据Key类型（keyType）来输入不同的内容
} }
func (x *CreateHTTPCacheTaskRequest) Reset() { func (x *CreateHTTPCacheTaskRequest) Reset() {
@@ -98,8 +98,8 @@ type CreateHTTPCacheTaskResponse struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` // 生成的任务ID
CountKeys int64 `protobuf:"varint,2,opt,name=countKeys,proto3" json:"countKeys,omitempty"` CountKeys int64 `protobuf:"varint,2,opt,name=countKeys,proto3" json:"countKeys,omitempty"` // 任务中包含的Key
} }
func (x *CreateHTTPCacheTaskResponse) Reset() { func (x *CreateHTTPCacheTaskResponse) Reset() {
@@ -232,7 +232,7 @@ type FindEnabledHTTPCacheTaskRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` // 任务ID
} }
func (x *FindEnabledHTTPCacheTaskRequest) Reset() { func (x *FindEnabledHTTPCacheTaskRequest) Reset() {
@@ -279,7 +279,7 @@ type FindEnabledHTTPCacheTaskResponse struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
HttpCacheTask *HTTPCacheTask `protobuf:"bytes,1,opt,name=httpCacheTask,proto3" json:"httpCacheTask,omitempty"` HttpCacheTask *HTTPCacheTask `protobuf:"bytes,1,opt,name=httpCacheTask,proto3" json:"httpCacheTask,omitempty"` // 任务信息
} }
func (x *FindEnabledHTTPCacheTaskResponse) Reset() { func (x *FindEnabledHTTPCacheTaskResponse) Reset() {
@@ -327,8 +327,8 @@ type ListHTTPCacheTasksRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
Offset int64 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"` Offset int64 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"` // 查询起始位置
Size int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` Size int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,omitempty"` // 查询条数
} }
func (x *ListHTTPCacheTasksRequest) Reset() { func (x *ListHTTPCacheTasksRequest) Reset() {
@@ -382,7 +382,7 @@ type ListHTTPCacheTasksResponse struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
HttpCacheTasks []*HTTPCacheTask `protobuf:"bytes,1,rep,name=httpCacheTasks,proto3" json:"httpCacheTasks,omitempty"` HttpCacheTasks []*HTTPCacheTask `protobuf:"bytes,1,rep,name=httpCacheTasks,proto3" json:"httpCacheTasks,omitempty"` // 一组任务信息
} }
func (x *ListHTTPCacheTasksResponse) Reset() { func (x *ListHTTPCacheTasksResponse) Reset() {
@@ -430,7 +430,7 @@ type DeleteHTTPCacheTaskRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` // 任务ID
} }
func (x *DeleteHTTPCacheTaskRequest) Reset() { func (x *DeleteHTTPCacheTaskRequest) Reset() {
@@ -478,7 +478,7 @@ type ResetHTTPCacheTaskRequest struct {
sizeCache protoimpl.SizeCache sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields unknownFields protoimpl.UnknownFields
HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"` // 任务ID
} }
func (x *ResetHTTPCacheTaskRequest) Reset() { func (x *ResetHTTPCacheTaskRequest) Reset() {

24
pkg/rpc/protos/service_http_cache_task.proto
View File

@@ -32,14 +32,14 @@ service HTTPCacheTaskService {
// 创建任务 // 创建任务
message CreateHTTPCacheTaskRequest { message CreateHTTPCacheTaskRequest {
string type = 1; // 类型：清理：purge，预热：fetch string type = 1; // 任务类型，值为 purge 或者 fetch；purge：删除缓存，fetch：预热缓存
string keyType = 2; // Key类型：单个URL：key，目录：prefix；预热的时候只能为 key string keyType = 2; // Key类型，值为 key 或者 prefix；如果是 key 表示处理的是URL，如果是 prefix 表示处理的是目录；预热的时候只能为 key
repeated string keys = 3; // 要清理的Key repeated string keys = 3; // 要清理的Key，根据Key类型（keyType）来输入不同的内容
} }
message CreateHTTPCacheTaskResponse { message CreateHTTPCacheTaskResponse {
int64 httpCacheTaskId = 1; int64 httpCacheTaskId = 1; // 生成的任务ID
int64 countKeys = 2; int64 countKeys = 2; // 任务中包含的Key
} }
// 计算任务总数量 // 计算任务总数量
@@ -54,29 +54,29 @@ message CountDoingHTTPCacheTasksRequest {
// 查找单个任务 // 查找单个任务
message FindEnabledHTTPCacheTaskRequest { message FindEnabledHTTPCacheTaskRequest {
int64 httpCacheTaskId = 1; int64 httpCacheTaskId = 1; // 任务ID
} }
message FindEnabledHTTPCacheTaskResponse { message FindEnabledHTTPCacheTaskResponse {
HTTPCacheTask httpCacheTask = 1; HTTPCacheTask httpCacheTask = 1; // 任务信息
} }
// 列出单页任务 // 列出单页任务
message ListHTTPCacheTasksRequest { message ListHTTPCacheTasksRequest {
int64 offset = 1; int64 offset = 1; // 查询起始位置
int64 size = 2; int64 size = 2; // 查询条数
} }
message ListHTTPCacheTasksResponse { message ListHTTPCacheTasksResponse {
repeated HTTPCacheTask httpCacheTasks = 1; repeated HTTPCacheTask httpCacheTasks = 1; // 一组任务信息
} }
// 删除任务 // 删除任务
message DeleteHTTPCacheTaskRequest { message DeleteHTTPCacheTaskRequest {
int64 httpCacheTaskId = 1; int64 httpCacheTaskId = 1; // 任务ID
} }
// 重置任务状态 // 重置任务状态
message ResetHTTPCacheTaskRequest { message ResetHTTPCacheTaskRequest {
int64 httpCacheTaskId = 1; int64 httpCacheTaskId = 1; // 任务ID
} }