aykhans/slash-e
1
0
Fork 0
mirror of https://github.com/aykhans/slash-e.git synced 2025-07-19 19:24:01 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore: initial workspace setting proto definition

Browse Source
This commit is contained in:
Steven
2023-09-12 08:50:23 +08:00
parent 032d9c1220
commit e843594a02
17 changed files with 1910 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

127
proto/gen/api/v2/README.md
View File

@@ -58,6 +58,16 @@
- [UserSettingService](#slash-api-v2-UserSettingService)
- [api/v2/workspace_setting_service.proto](#api_v2_workspace_setting_service-proto)
- [AutoBackupWorkspaceSetting](#slash-api-v2-AutoBackupWorkspaceSetting)
- [GetWorkspaceSettingRequest](#slash-api-v2-GetWorkspaceSettingRequest)
- [GetWorkspaceSettingResponse](#slash-api-v2-GetWorkspaceSettingResponse)
- [UpdateWorkspaceSettingRequest](#slash-api-v2-UpdateWorkspaceSettingRequest)
- [UpdateWorkspaceSettingResponse](#slash-api-v2-UpdateWorkspaceSettingResponse)
- [WorkspaceSetting](#slash-api-v2-WorkspaceSetting)
- [WorkspaceSettingService](#slash-api-v2-WorkspaceSettingService)
- [Scalar Value Types](#scalar-value-types)
@@ -734,6 +744,123 @@
<a name="api_v2_workspace_setting_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
## api/v2/workspace_setting_service.proto
<a name="slash-api-v2-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, &#34;0 0 0 * * *&#34; 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-api-v2-GetWorkspaceSettingRequest"></a>
### GetWorkspaceSettingRequest
<a name="slash-api-v2-GetWorkspaceSettingResponse"></a>
### GetWorkspaceSettingResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| setting | [WorkspaceSetting](#slash-api-v2-WorkspaceSetting) | | The user setting. |
<a name="slash-api-v2-UpdateWorkspaceSettingRequest"></a>
### UpdateWorkspaceSettingRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| setting | [WorkspaceSetting](#slash-api-v2-WorkspaceSetting) | | The user setting. |
| update_mask | [string](#string) | repeated | The update mask. |
<a name="slash-api-v2-UpdateWorkspaceSettingResponse"></a>
### UpdateWorkspaceSettingResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| setting | [WorkspaceSetting](#slash-api-v2-WorkspaceSetting) | | The user setting. |
<a name="slash-api-v2-WorkspaceSetting"></a>
### WorkspaceSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| enable_signup | [bool](#bool) | | Whether to enable other users to sign up. |
| resource_relative_path | [string](#string) | | The relative path of the resource directory. |
| auto_backup | [AutoBackupWorkspaceSetting](#slash-api-v2-AutoBackupWorkspaceSetting) | | The auto backup setting. |
<a name="slash-api-v2-WorkspaceSettingService"></a>
### WorkspaceSettingService
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| GetWorkspaceSetting | [GetWorkspaceSettingRequest](#slash-api-v2-GetWorkspaceSettingRequest) | [GetWorkspaceSettingResponse](#slash-api-v2-GetWorkspaceSettingResponse) | |
| UpdateWorkspaceSetting | [UpdateWorkspaceSettingRequest](#slash-api-v2-UpdateWorkspaceSettingRequest) | [UpdateWorkspaceSettingResponse](#slash-api-v2-UpdateWorkspaceSettingResponse) | |
## Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |