memos/proto/gen/store
2023-12-19 22:34:06 +08:00
..
activity.pb.go feat: add version checker 2023-11-06 20:49:02 +08:00
common.pb.go chore: implement webhook store 2023-11-24 22:45:38 +08:00
inbox.pb.go feat: add version checker 2023-11-06 20:49:02 +08:00
README.md chore: retire auto backup for sqlite 2023-12-19 22:34:06 +08:00
system_setting.pb.go chore: retire auto backup for sqlite 2023-12-19 22:34:06 +08:00
user_setting.pb.go chore: update user setting api 2023-11-30 23:08:54 +08:00
webhook.pb.go chore: implement webhook store 2023-11-24 22:45:38 +08:00

Protocol Documentation

Table of Contents

Top

store/activity.proto

ActivityMemoCommentPayload

Field Type Label Description
memo_id int32
related_memo_id int32

ActivityPayload

Field Type Label Description
memo_comment ActivityMemoCommentPayload
version_update ActivityVersionUpdatePayload

ActivityVersionUpdatePayload

Field Type Label Description
version string

Top

store/common.proto

RowStatus

Name Number Description
ROW_STATUS_UNSPECIFIED 0
NORMAL 1
ARCHIVED 2

Top

store/inbox.proto

InboxMessage

Field Type Label Description
type InboxMessage.Type
activity_id int32 optional

InboxMessage.Type

Name Number Description
TYPE_UNSPECIFIED 0
TYPE_MEMO_COMMENT 1
TYPE_VERSION_UPDATE 2

Top

store/system_setting.proto

SystemSettingKey

Name Number Description
SYSTEM_SETTING_KEY_UNSPECIFIED 0

Top

store/user_setting.proto

AccessTokensUserSetting

Field Type Label Description
access_tokens AccessTokensUserSetting.AccessToken repeated

AccessTokensUserSetting.AccessToken

Field Type Label Description
access_token string The access token is a JWT token. Including expiration time, issuer, etc.
description string A description for the access token.

UserSetting

Field Type Label Description
user_id int32
key UserSettingKey
access_tokens AccessTokensUserSetting
locale string
appearance string
memo_visibility string
telegram_user_id string

UserSettingKey

Name Number Description
USER_SETTING_KEY_UNSPECIFIED 0
USER_SETTING_ACCESS_TOKENS 1 Access tokens for the user.
USER_SETTING_LOCALE 2 The locale of the user.
USER_SETTING_APPEARANCE 3 The appearance of the user.
USER_SETTING_MEMO_VISIBILITY 4 The visibility of the memo.
USER_SETTING_TELEGRAM_USER_ID 5 The telegram user id of the user.

Top

store/webhook.proto

Webhook

Field Type Label Description
id int32
created_ts int64
updated_ts int64
creator_id int32
row_status RowStatus
name string
url string

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)