slash-e/proto/gen/store/README.md

Protocol Documentation

Table of Contents

• store/activity.proto

  • ActivityShorcutCreatePayload
  • ActivityShorcutViewPayload

• store/common.proto

  • RowStatus
  • Visibility

• store/collection.proto

  • Collection

• store/memo.proto

  • Memo

• store/shortcut.proto

  • OpenGraphMetadata
  • Shortcut

• store/user_setting.proto

  • AccessTokensUserSetting

  • AccessTokensUserSetting.AccessToken

  • UserSetting

  • ColorThemeUserSetting

  • LocaleUserSetting

  • UserSettingKey

• store/workspace_setting.proto

  • AutoBackupWorkspaceSetting

  • WorkspaceSetting

  • WorkspaceSettingKey

• Scalar Value Types

Top

store/activity.proto

ActivityShorcutCreatePayload

Field	Type	Label	Description
shortcut_id	int32

ActivityShorcutViewPayload

Field	Type	Label	Description
shortcut_id	int32
ip	string
referer	string
user_agent	string

Top

store/common.proto

RowStatus

Name	Number	Description
ROW_STATUS_UNSPECIFIED	0
NORMAL	1
ARCHIVED	2

Visibility

Name	Number	Description
VISIBILITY_UNSPECIFIED	0
PRIVATE	1
WORKSPACE	2
PUBLIC	3

Top

store/collection.proto

Collection

Field	Type	Label	Description
id	int32
creator_id	int32
created_ts	int64
updated_ts	int64
name	string
title	string
description	string
shortcut_ids	int32	repeated
visibility	Visibility

Top

store/memo.proto

Memo

Field	Type	Label	Description
id	int32
creator_id	int32
created_ts	int64
updated_ts	int64
row_status	RowStatus
name	string
title	string
content	string
tags	string	repeated
visibility	Visibility

Top

store/shortcut.proto

OpenGraphMetadata

Field	Type	Label	Description
title	string
description	string
image	string

Shortcut

Field	Type	Label	Description
id	int32
creator_id	int32
created_ts	int64
updated_ts	int64
row_status	RowStatus
name	string
link	string
title	string
tags	string	repeated
description	string
visibility	Visibility
og_metadata	OpenGraphMetadata

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	LocaleUserSetting
color_theme	ColorThemeUserSetting

ColorThemeUserSetting

Name	Number	Description
COLOR_THEME_USER_SETTING_UNSPECIFIED	0
COLOR_THEME_USER_SETTING_SYSTEM	1
COLOR_THEME_USER_SETTING_LIGHT	2
COLOR_THEME_USER_SETTING_DARK	3

LocaleUserSetting

Name	Number	Description
LOCALE_USER_SETTING_UNSPECIFIED	0
LOCALE_USER_SETTING_EN	1
LOCALE_USER_SETTING_ZH	2

UserSettingKey

Name	Number	Description
USER_SETTING_KEY_UNSPECIFIED	0
USER_SETTING_ACCESS_TOKENS	1	Access tokens for the user.
USER_SETTING_LOCALE	2	Locale for the user.
USER_SETTING_COLOR_THEME	3	Color theme for the user.

Top

store/workspace_setting.proto

AutoBackupWorkspaceSetting

Field	Type	Label	Description
enabled	bool		Whether auto backup is enabled.
cron_expression	string		The cron expression for auto backup. For example, "0 0 0 * * *" means backup at 00:00:00 every day. See https://en.wikipedia.org/wiki/Cron for more details.
max_keep	int32		The maximum number of backups to keep.

WorkspaceSetting

Field	Type	Label	Description
key	WorkspaceSettingKey
license_key	string		The license key of workspace.
secret_session	string		The secret session key used to encrypt session data.
enable_signup	bool		Whether to enable other users to sign up.
custom_style	string		The custom style.
custom_script	string		The custom script.
auto_backup	AutoBackupWorkspaceSetting		The auto backup setting. (Unimplemented)
instance_url	string		The instance URL of workspace.
default_visibility	Visibility		The default visibility of shortcuts and collections.

WorkspaceSettingKey

Name	Number	Description
WORKSPACE_SETTING_KEY_UNSPECIFIED	0
WORKSPACE_SETTING_LICENSE_KEY	1	The license key.
WORKSPACE_SETTING_SECRET_SESSION	2	The secret session key used to encrypt session data.
WORKSAPCE_SETTING_ENABLE_SIGNUP	3	Whether to enable other users to sign up.
WORKSPACE_SETTING_CUSTOM_STYLE	4	The custom style.
WORKSPACE_SETTING_CUSTOM_SCRIPT	5	The custom script.
WORKSPACE_SETTING_AUTO_BACKUP	6	The auto backup setting.
WORKSPACE_SETTING_INSTANCE_URL	7	The instance URL.
WORKSPACE_SETTING_DEFAULT_VISIBILITY	8	The default visibility of shortcuts and collections.

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)