增加一些API注释

2025-11-03 12:20:27 +08:00 · 2023-08-06 19:33:45 +08:00
parent 117c89ff62
commit 65be70d015
3 changed files with 32 additions and 32 deletions
--- a/build/rpc.json
+++ b/build/rpc.json
@@ -14814,12 +14814,12 @@
    },
    {
      "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": "创建任务"
    },
    {
      "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": ""
    },
    {
@@ -15759,7 +15759,7 @@
    },
    {
      "name": "DeleteHTTPCacheTaskRequest",
-      "code": "message DeleteHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1;\n}",
+      "code": "message DeleteHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1; // 任务ID\n}",
      "doc": "删除任务"
    },
    {
@@ -17759,12 +17759,12 @@
    },
    {
      "name": "FindEnabledHTTPCacheTaskRequest",
-      "code": "message FindEnabledHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1;\n}",
+      "code": "message FindEnabledHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1; // 任务ID\n}",
      "doc": "查找单个任务"
    },
    {
      "name": "FindEnabledHTTPCacheTaskResponse",
-      "code": "message FindEnabledHTTPCacheTaskResponse {\n\tHTTPCacheTask httpCacheTask = 1;\n}",
+      "code": "message FindEnabledHTTPCacheTaskResponse {\n\tHTTPCacheTask httpCacheTask = 1; // 任务信息\n}",
      "doc": ""
    },
    {
@@ -20289,12 +20289,12 @@
    },
    {
      "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": "列出单页任务"
    },
    {
      "name": "ListHTTPCacheTasksResponse",
-      "code": "message ListHTTPCacheTasksResponse {\n\trepeated HTTPCacheTask httpCacheTasks = 1;\n}",
+      "code": "message ListHTTPCacheTasksResponse {\n\trepeated HTTPCacheTask httpCacheTasks = 1; // 一组任务信息\n}",
      "doc": ""
    },
    {
@@ -21184,7 +21184,7 @@
    },
    {
      "name": "ResetHTTPCacheTaskRequest",
-      "code": "message ResetHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1;\n}",
+      "code": "message ResetHTTPCacheTaskRequest {\n\tint64 httpCacheTaskId = 1; // 任务ID\n}",
      "doc": "重置任务状态"
    },
    {
--- a/pkg/rpc/pb/service_http_cache_task.pb.go
+++ b/pkg/rpc/pb/service_http_cache_task.pb.go
@@ -35,9 +35,9 @@ type CreateHTTPCacheTaskRequest struct {
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields

-	Type    string   `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"`       // 类型：清理：purge，预热：fetch
-	KeyType string   `protobuf:"bytes,2,opt,name=keyType,proto3" json:"keyType,omitempty"` // Key类型：单个URL：key，目录：prefix；预热的时候只能为 key
-	Keys    []string `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`       // 要清理的Key
+	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类型，值为 key 或者 prefix；如果是 key 表示处理的是URL，如果是 prefix 表示处理的是目录；预热的时候只能为 key
+	Keys    []string `protobuf:"bytes,3,rep,name=keys,proto3" json:"keys,omitempty"`       // 要清理的Key，根据Key类型（keyType）来输入不同的内容
 }

 func (x *CreateHTTPCacheTaskRequest) Reset() {
@@ -98,8 +98,8 @@ type CreateHTTPCacheTaskResponse struct {
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields

-	HttpCacheTaskId int64 `protobuf:"varint,1,opt,name=httpCacheTaskId,proto3" json:"httpCacheTaskId,omitempty"`
-	CountKeys       int64 `protobuf:"varint,2,opt,name=countKeys,proto3" json:"countKeys,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"`             // 任务中包含的Key
 }

 func (x *CreateHTTPCacheTaskResponse) Reset() {
@@ -232,7 +232,7 @@ type FindEnabledHTTPCacheTaskRequest struct {
 	sizeCache     protoimpl.SizeCache
 	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() {
@@ -279,7 +279,7 @@ type FindEnabledHTTPCacheTaskResponse struct {
 	sizeCache     protoimpl.SizeCache
 	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() {
@@ -327,8 +327,8 @@ type ListHTTPCacheTasksRequest struct {
 	sizeCache     protoimpl.SizeCache
 	unknownFields protoimpl.UnknownFields

-	Offset int64 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
-	Size   int64 `protobuf:"varint,2,opt,name=size,proto3" json:"size,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"`     // 查询条数
 }

 func (x *ListHTTPCacheTasksRequest) Reset() {
@@ -382,7 +382,7 @@ type ListHTTPCacheTasksResponse struct {
 	sizeCache     protoimpl.SizeCache
 	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() {
@@ -430,7 +430,7 @@ type DeleteHTTPCacheTaskRequest struct {
 	sizeCache     protoimpl.SizeCache
 	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() {
@@ -478,7 +478,7 @@ type ResetHTTPCacheTaskRequest struct {
 	sizeCache     protoimpl.SizeCache
 	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() {
--- a/pkg/rpc/protos/service_http_cache_task.proto
+++ b/pkg/rpc/protos/service_http_cache_task.proto
@@ -32,14 +32,14 @@ service HTTPCacheTaskService {

 // 创建任务
 message CreateHTTPCacheTaskRequest {
-	string type = 1; // 类型：清理：purge，预热：fetch
-	string keyType = 2; // Key类型：单个URL：key，目录：prefix；预热的时候只能为 key
-	repeated string keys = 3; // 要清理的Key
+	string type = 1; // 任务类型，值为 purge 或者 fetch；purge：删除缓存，fetch：预热缓存
+	string keyType = 2; // Key类型，值为 key 或者 prefix；如果是 key 表示处理的是URL，如果是 prefix 表示处理的是目录；预热的时候只能为 key
+	repeated string keys = 3; // 要清理的Key，根据Key类型（keyType）来输入不同的内容
 }

 message CreateHTTPCacheTaskResponse {
-	int64 httpCacheTaskId = 1;
-	int64 countKeys = 2;
+	int64 httpCacheTaskId = 1; // 生成的任务ID
+	int64 countKeys = 2; // 任务中包含的Key
 }

 // 计算任务总数量
@@ -54,29 +54,29 @@ message CountDoingHTTPCacheTasksRequest {

 // 查找单个任务
 message FindEnabledHTTPCacheTaskRequest {
-	int64 httpCacheTaskId = 1;
+	int64 httpCacheTaskId = 1; // 任务ID
 }

 message FindEnabledHTTPCacheTaskResponse {
-	HTTPCacheTask httpCacheTask = 1;
+	HTTPCacheTask httpCacheTask = 1; // 任务信息
 }

 // 列出单页任务
 message ListHTTPCacheTasksRequest {
-	int64 offset = 1;
-	int64 size = 2;
+	int64 offset = 1; // 查询起始位置
+	int64 size = 2; // 查询条数
 }

 message ListHTTPCacheTasksResponse {
-	repeated HTTPCacheTask httpCacheTasks = 1;
+	repeated HTTPCacheTask httpCacheTasks = 1; // 一组任务信息
 }

 // 删除任务
 message DeleteHTTPCacheTaskRequest {
-	int64 httpCacheTaskId = 1;
+	int64 httpCacheTaskId = 1; // 任务ID
 }

 // 重置任务状态
 message ResetHTTPCacheTaskRequest {
-	int64 httpCacheTaskId = 1;
+	int64 httpCacheTaskId = 1; // 任务ID
 }