You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7.1 KiB
7.1 KiB
Protocol Documentation
Table of Contents
api/v1/comment.proto
CheckCommentRequest
审核评论,修改评论状态
Field | Type | Label | Description |
---|---|---|---|
id | int64 | repeated | 评论ID |
status | int32 | 状态,见 web/utils/enum.js 枚举 |
Comment
评论
Field | Type | Label | Description |
---|---|---|---|
created_at | google.protobuf.Timestamp | 创建时间 | |
updated_at | google.protobuf.Timestamp | 更新时间 | |
id | int64 | 评论ID | |
parent_id | int64 | 父评论ID | |
content | string | 评论内容 | |
document_id | int64 | 文档ID | |
status | int32 | 状态,见 web/utils/enum.js 枚举 | |
comment_count | int32 | 回复数量 | |
user_id | int64 | 用户ID | |
user | User | 用户信息 | |
document_title | string | 文档标题 |
CreateCommentRequest
创建评论请求
Field | Type | Label | Description |
---|---|---|---|
document_id | int64 | 文档ID | |
parent_id | int64 | 父评论ID | |
content | string | 评论内容 | |
captcha_id | string | 验证码ID | |
captcha | string | 验证码 |
DeleteCommentRequest
删除评论请求
Field | Type | Label | Description |
---|---|---|---|
id | int64 | repeated |
GetCommentRequest
获取评论请求
Field | Type | Label | Description |
---|---|---|---|
id | int64 |
ListCommentReply
获取评论列表响应
Field | Type | Label | Description |
---|---|---|---|
total | int64 | 总数 | |
comment | Comment | repeated | 评论列表 |
ListCommentRequest
获取评论列表请求
Field | Type | Label | Description |
---|---|---|---|
page | int64 | 页码 | |
size | int64 | 每页数量 | |
wd | string | 搜索关键词 | |
field | string | repeated | 查询的数据字段 |
order | string | 排序字段 | |
status | int32 | repeated | 状态,见 web/utils/enum.js 枚举 |
document_id | int64 | 文档ID | |
user_id | int64 | 用户ID | |
parent_id | int64 | repeated | 父评论ID |
with_document_title | bool | 是否返回文档标题 |
CommentAPI
评论服务
Method Name | Request Type | Response Type | Description |
---|---|---|---|
CreateComment | CreateCommentRequest | .google.protobuf.Empty | 创建评论 |
UpdateComment | Comment | .google.protobuf.Empty | 更新评论,仅限管理员操作 |
DeleteComment | DeleteCommentRequest | .google.protobuf.Empty | 管理员或用户自己删除自己的评论 |
GetComment | GetCommentRequest | Comment | 获取单个评论 |
ListComment | ListCommentRequest | ListCommentReply | 获取评论列表 |
CheckComment | CheckCommentRequest | .google.protobuf.Empty | 审核评论 |
Scalar Value Types
.proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
---|---|---|---|---|---|---|---|---|
double | double | double | float | float64 | double | float | Float | |
float | float | float | float | float32 | float | float | Float | |
int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |