增加部分API注释

This commit is contained in:
刘祥超
2023-07-09 10:15:33 +08:00
parent 1c192050c7
commit 8639bd213e
5 changed files with 24 additions and 24 deletions

View File

@@ -7,7 +7,7 @@ import "models/model_user.proto";
import "models/model_http_cache_task_key.proto";
message HTTPCacheTask {
int64 id = 1;
int64 id = 1; // 任务ID
int64 userId = 2;
string type = 3;
string keyType = 4;
@@ -17,6 +17,6 @@ message HTTPCacheTask {
bool isOk = 8;
string description = 9;
User user = 30;
repeated HTTPCacheTaskKey httpCacheTaskKeys = 31;
User user = 30; // 所属用户
repeated HTTPCacheTaskKey httpCacheTaskKeys = 31; // 包含的Key
}

View File

@@ -4,13 +4,13 @@ option go_package = "./pb";
package pb;
message HTTPCacheTaskKey {
int64 id = 1;
int64 taskId = 2;
string key = 3;
string type = 4;
string keyType = 5;
int64 id = 1; // 缓存键ID
int64 taskId = 2; // 任务ID
string key = 3; // 缓存键
string type = 4; // 操作类型purge|fetch
string keyType = 5; // 键类型key|prefix
bool isDone = 6; // 是否已完成
bool isDoing = 9; // 是否执行中
bytes errorsJSON = 7;
int64 nodeClusterId = 8;
bytes errorsJSON = 7; // 错误信息
int64 nodeClusterId = 8; // 所属集群ID
}