mirror of
https://github.com/aykhans/slash-e.git
synced 2025-04-21 06:13:33 +00:00
341 lines
8.4 KiB
Markdown
341 lines
8.4 KiB
Markdown
# Protocol Documentation
|
||
<a name="top"></a>
|
||
|
||
## Table of Contents
|
||
|
||
- [store/activity.proto](#store_activity-proto)
|
||
- [ActivityShorcutCreatePayload](#slash-store-ActivityShorcutCreatePayload)
|
||
|
||
- [store/common.proto](#store_common-proto)
|
||
- [RowStatus](#slash-store-RowStatus)
|
||
|
||
- [store/shortcut.proto](#store_shortcut-proto)
|
||
- [OpenGraphMetadata](#slash-store-OpenGraphMetadata)
|
||
- [Shortcut](#slash-store-Shortcut)
|
||
|
||
- [Visibility](#slash-store-Visibility)
|
||
|
||
- [store/user_setting.proto](#store_user_setting-proto)
|
||
- [AccessTokensUserSetting](#slash-store-AccessTokensUserSetting)
|
||
- [AccessTokensUserSetting.AccessToken](#slash-store-AccessTokensUserSetting-AccessToken)
|
||
- [UserSetting](#slash-store-UserSetting)
|
||
|
||
- [LocaleUserSetting](#slash-store-LocaleUserSetting)
|
||
- [UserSettingKey](#slash-store-UserSettingKey)
|
||
|
||
- [store/workspace_setting.proto](#store_workspace_setting-proto)
|
||
- [AutoBackupWorkspaceSetting](#slash-store-AutoBackupWorkspaceSetting)
|
||
- [WorkspaceSetting](#slash-store-WorkspaceSetting)
|
||
|
||
- [WorkspaceSettingKey](#slash-store-WorkspaceSettingKey)
|
||
|
||
- [Scalar Value Types](#scalar-value-types)
|
||
|
||
|
||
|
||
<a name="store_activity-proto"></a>
|
||
<p align="right"><a href="#top">Top</a></p>
|
||
|
||
## store/activity.proto
|
||
|
||
|
||
|
||
<a name="slash-store-ActivityShorcutCreatePayload"></a>
|
||
|
||
### ActivityShorcutCreatePayload
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| shortcut_id | [int32](#int32) | | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="store_common-proto"></a>
|
||
<p align="right"><a href="#top">Top</a></p>
|
||
|
||
## store/common.proto
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-RowStatus"></a>
|
||
|
||
### RowStatus
|
||
|
||
|
||
| Name | Number | Description |
|
||
| ---- | ------ | ----------- |
|
||
| ROW_STATUS_UNSPECIFIED | 0 | |
|
||
| NORMAL | 1 | |
|
||
| ARCHIVED | 2 | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="store_shortcut-proto"></a>
|
||
<p align="right"><a href="#top">Top</a></p>
|
||
|
||
## store/shortcut.proto
|
||
|
||
|
||
|
||
<a name="slash-store-OpenGraphMetadata"></a>
|
||
|
||
### OpenGraphMetadata
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| title | [string](#string) | | |
|
||
| description | [string](#string) | | |
|
||
| image | [string](#string) | | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-Shortcut"></a>
|
||
|
||
### Shortcut
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| id | [int32](#int32) | | |
|
||
| creator_id | [int32](#int32) | | |
|
||
| created_ts | [int64](#int64) | | |
|
||
| updated_ts | [int64](#int64) | | |
|
||
| row_status | [RowStatus](#slash-store-RowStatus) | | |
|
||
| name | [string](#string) | | |
|
||
| link | [string](#string) | | |
|
||
| title | [string](#string) | | |
|
||
| tags | [string](#string) | repeated | |
|
||
| description | [string](#string) | | |
|
||
| visibility | [Visibility](#slash-store-Visibility) | | |
|
||
| og_metadata | [OpenGraphMetadata](#slash-store-OpenGraphMetadata) | | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-Visibility"></a>
|
||
|
||
### Visibility
|
||
|
||
|
||
| Name | Number | Description |
|
||
| ---- | ------ | ----------- |
|
||
| VISIBILITY_UNSPECIFIED | 0 | |
|
||
| PRIVATE | 1 | |
|
||
| WORKSPACE | 2 | |
|
||
| PUBLIC | 3 | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="store_user_setting-proto"></a>
|
||
<p align="right"><a href="#top">Top</a></p>
|
||
|
||
## store/user_setting.proto
|
||
|
||
|
||
|
||
<a name="slash-store-AccessTokensUserSetting"></a>
|
||
|
||
### AccessTokensUserSetting
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| access_tokens | [AccessTokensUserSetting.AccessToken](#slash-store-AccessTokensUserSetting-AccessToken) | repeated | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-AccessTokensUserSetting-AccessToken"></a>
|
||
|
||
### AccessTokensUserSetting.AccessToken
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| access_token | [string](#string) | | |
|
||
| description | [string](#string) | | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-UserSetting"></a>
|
||
|
||
### UserSetting
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| user_id | [int32](#int32) | | |
|
||
| key | [UserSettingKey](#slash-store-UserSettingKey) | | |
|
||
| access_tokens_user_setting | [AccessTokensUserSetting](#slash-store-AccessTokensUserSetting) | | |
|
||
| locale_user_setting | [LocaleUserSetting](#slash-store-LocaleUserSetting) | | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-LocaleUserSetting"></a>
|
||
|
||
### LocaleUserSetting
|
||
|
||
|
||
| Name | Number | Description |
|
||
| ---- | ------ | ----------- |
|
||
| LOCALE_USER_SETTING_UNSPECIFIED | 0 | |
|
||
| LOCALE_USER_SETTING_EN | 1 | |
|
||
| LOCALE_USER_SETTING_ZH | 2 | |
|
||
|
||
|
||
|
||
<a name="slash-store-UserSettingKey"></a>
|
||
|
||
### UserSettingKey
|
||
|
||
|
||
| Name | Number | Description |
|
||
| ---- | ------ | ----------- |
|
||
| USER_SETTING_KEY_UNSPECIFIED | 0 | |
|
||
| USER_SETTING_ACCESS_TOKENS | 1 | |
|
||
| USER_SETTING_LOCALE | 2 | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="store_workspace_setting-proto"></a>
|
||
<p align="right"><a href="#top">Top</a></p>
|
||
|
||
## store/workspace_setting.proto
|
||
|
||
|
||
|
||
<a name="slash-store-AutoBackupWorkspaceSetting"></a>
|
||
|
||
### AutoBackupWorkspaceSetting
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| enabled | [bool](#bool) | | Whether auto backup is enabled. |
|
||
| cron_expression | [string](#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](#int32) | | The maximum number of backups to keep. |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-WorkspaceSetting"></a>
|
||
|
||
### WorkspaceSetting
|
||
|
||
|
||
|
||
| Field | Type | Label | Description |
|
||
| ----- | ---- | ----- | ----------- |
|
||
| key | [WorkspaceSettingKey](#slash-store-WorkspaceSettingKey) | | |
|
||
| auto_backup | [AutoBackupWorkspaceSetting](#slash-store-AutoBackupWorkspaceSetting) | | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<a name="slash-store-WorkspaceSettingKey"></a>
|
||
|
||
### WorkspaceSettingKey
|
||
|
||
|
||
| Name | Number | Description |
|
||
| ---- | ------ | ----------- |
|
||
| WORKSPACE_SETTING_KEY_UNSPECIFIED | 0 | |
|
||
| WORKSPACE_SETTING_AUTO_BACKUP | 1 | |
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
## Scalar Value Types
|
||
|
||
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
|
||
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
|
||
| <a name="double" /> double | | double | double | float | float64 | double | float | Float |
|
||
| <a name="float" /> float | | float | float | float | float32 | float | float | Float |
|
||
| <a name="int32" /> 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) |
|
||
| <a name="int64" /> 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 |
|
||
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
|
||
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
|
||
| <a name="sint32" /> 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) |
|
||
| <a name="sint64" /> 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 |
|
||
| <a name="fixed32" /> 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) |
|
||
| <a name="fixed64" /> 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 |
|
||
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
|
||
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
|
||
| <a name="bool" /> bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
|
||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
|
||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
|
||
|