chore: add user setting service definition

This commit is contained in:
steven
2023-09-03 13:06:03 +08:00
parent 4733e4796d
commit a970d85e14
7 changed files with 1293 additions and 0 deletions

View File

@@ -44,6 +44,15 @@
- [UserService](#slash-api-v2-UserService)
- [api/v2/user_setting_service.proto](#api_v2_user_setting_service-proto)
- [GetUserSettingRequest](#slash-api-v2-GetUserSettingRequest)
- [GetUserSettingResponse](#slash-api-v2-GetUserSettingResponse)
- [UpdateUserSettingRequest](#slash-api-v2-UpdateUserSettingRequest)
- [UpdateUserSettingResponse](#slash-api-v2-UpdateUserSettingResponse)
- [UserSetting](#slash-api-v2-UserSetting)
- [UserSettingService](#slash-api-v2-UserSettingService)
- [Scalar Value Types](#scalar-value-types)
@@ -555,6 +564,110 @@
<a name="api_v2_user_setting_service-proto"></a>
<p align="right"><a href="#top">Top</a></p>
## api/v2/user_setting_service.proto
<a name="slash-api-v2-GetUserSettingRequest"></a>
### GetUserSettingRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int32](#int32) | | id is the user id. |
<a name="slash-api-v2-GetUserSettingResponse"></a>
### GetUserSettingResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user_setting | [UserSetting](#slash-api-v2-UserSetting) | | |
<a name="slash-api-v2-UpdateUserSettingRequest"></a>
### UpdateUserSettingRequest
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int32](#int32) | | id is the user id. |
| user_setting | [UserSetting](#slash-api-v2-UserSetting) | | |
<a name="slash-api-v2-UpdateUserSettingResponse"></a>
### UpdateUserSettingResponse
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| user_setting | [UserSetting](#slash-api-v2-UserSetting) | | |
<a name="slash-api-v2-UserSetting"></a>
### UserSetting
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int32](#int32) | | id is the user id. |
| locale | [string](#string) | | locale is the user locale. |
<a name="slash-api-v2-UserSettingService"></a>
### UserSettingService
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| GetUserSetting | [GetUserSettingRequest](#slash-api-v2-GetUserSettingRequest) | [GetUserSettingResponse](#slash-api-v2-GetUserSettingResponse) | GetUserSetting returns the user setting. |
| UpdateUserSetting | [UpdateUserSettingRequest](#slash-api-v2-UpdateUserSettingRequest) | [UpdateUserSettingResponse](#slash-api-v2-UpdateUserSettingResponse) | UpdateUserSetting updates the user setting. |
## Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |