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.
6.5 KiB
6.5 KiB
Protocol Documentation
Table of Contents
api/v1/attachment.proto
Attachment
附件
Field | Type | Label | Description |
---|---|---|---|
id | int64 | 附件ID | |
hash | string | 附件哈希值,MD5 | |
user_id | int64 | 上传用户ID | |
type_id | int64 | 附件类型ID,如果是文档类型,则为文档ID | |
type | int32 | 附件类型,见 web/utils/enum.js | |
enable | bool | 是否启用 | |
path | string | 附件路径 | |
name | string | 附件名称 | |
size | int64 | 附件大小,单位:字节 | |
width | int64 | 附件宽度,单位:像素。针对图片附件 | |
height | int64 | 附件高度,单位:像素。针对图片附件 | |
ext | string | 扩展名,如:.docx | |
ip | string | 上传IP地址 | |
username | string | 用户名称 | |
type_name | string | 附件类型名称 | |
description | string | 附件描述、备注 | |
created_at | google.protobuf.Timestamp | 创建时间 | |
updated_at | google.protobuf.Timestamp | 更新时间 |
DeleteAttachmentRequest
删除附件请求
Field | Type | Label | Description |
---|---|---|---|
id | int64 | repeated |
GetAttachmentRequest
获取附件请求
Field | Type | Label | Description |
---|---|---|---|
id | int64 |
ListAttachmentReply
列出附件响应
Field | Type | Label | Description |
---|---|---|---|
total | int64 | ||
attachment | Attachment | repeated |
ListAttachmentRequest
列出附件请求
Field | Type | Label | Description |
---|---|---|---|
page | int64 | 页码 | |
size | int64 | 每页数量 | |
wd | string | 搜索关键字 | |
enable | bool | repeated | 是否启用 |
user_id | int64 | repeated | 用户ID |
type | int64 | repeated | 类型 |
ext | string | 扩展名 |
AttachmentAPI
附件服务。只有管理员才有权限操作
Method Name | Request Type | Response Type | Description |
---|---|---|---|
UpdateAttachment | Attachment | .google.protobuf.Empty | 更新附件 |
DeleteAttachment | DeleteAttachmentRequest | .google.protobuf.Empty | 删除附件。这里只是软删除,不会真正删除附件,默认24小时候会真正清除附件 |
GetAttachment | GetAttachmentRequest | Attachment | 查询附件 |
ListAttachment | ListAttachmentRequest | ListAttachmentReply | 列出附件 |
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) |