# README
Protocol Documentation
Table of Contents
user.proto
GetLoginByUUIDIn
Field | Type | Label | Description |
---|---|---|---|
uuid | string |
GetLoginByUUIDOut
Field | Type | Label | Description |
---|---|---|---|
login | string |
GetOs
Field | Type | Label | Description |
---|---|---|---|
id | int64 | ||
label | string |
GetUserByLoginIn
Data in request or getting uuid by login. If User doesnt exist - user will be creating
Field | Type | Label | Description |
---|---|---|---|
login | string | Email of target user |
GetUserByLoginOut
Message for response
Field | Type | Label | Description |
---|---|---|---|
uuid | string | UUID of user | |
isNewUser | bool | Flag for indicate of new user |
GetUserInfoByUUIDIn
Request data fo getting user info (for initiator page)
Field | Type | Label | Description |
---|---|---|---|
uuid | string | UUID for target user |
GetUserInfoByUUIDOut
Response data for initiator page
Field | Type | Label | Description |
---|---|---|---|
nickname | string | ||
avatar | string | ||
name | string | optional | |
surname | string | optional | |
birthdate | string | optional | |
phone | string | optional | |
city | string | optional | |
telegram | string | optional | |
git | string | optional | |
os | GetOs | optional | |
work | string | optional | |
university | string | optional | |
skills | string | repeated | |
hobbies | string | repeated |
GetUserWithOffsetIn
Field | Type | Label | Description |
---|---|---|---|
limit | int64 | ||
offset | int64 | ||
nickname | string |
GetUserWithOffsetOut
Field | Type | Label | Description |
---|---|---|---|
user | User | repeated | |
total | int64 |
IsUserExistByUUIDIn
Message for request
Field | Type | Label | Description |
---|---|---|---|
uuid | string | UUID for target user |
IsUserExistByUUIDOut
Message for response
Field | Type | Label | Description |
---|---|---|---|
isExist | bool | Flag of indicate user exist |
UpdateProfileIn
Field | Type | Label | Description |
---|---|---|---|
name | string | ||
birthday | string | ||
telegram | string | ||
github | string | ||
os_id | int64 |
UpdateProfileOut
Field | Type | Label | Description |
---|---|---|---|
status | bool |
User
Field | Type | Label | Description |
---|---|---|---|
nickname | string | ||
uuid | string | ||
avatar_link | string | ||
name | string | ||
surname | string |
UserService
Service for friends
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetUserByLogin | .GetUserByLoginIn | .GetUserByLoginOut | Add friends method |
IsUserExistByUUID | .IsUserExistByUUIDIn | .IsUserExistByUUIDOut | |
GetUserInfoByUUID | .GetUserInfoByUUIDIn | .GetUserInfoByUUIDOut | |
GetLoginByUUID | .GetLoginByUUIDIn | .GetLoginByUUIDOut | |
GetUserWithOffset | .GetUserWithOffsetIn | .GetUserWithOffsetOut | |
UpdateProfile | .UpdateProfileIn | .UpdateProfileOut |
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) |
# Packages
No description provided by the author