Categorygithub.com/s21platform/user-proto
module
0.0.11
Repository: https://github.com/s21platform/user-proto.git
Documentation: pkg.go.dev

# README

Protocol Documentation

Table of Contents

Top

user.proto

GetLoginByUUIDIn

FieldTypeLabelDescription
uuidstring

GetLoginByUUIDOut

FieldTypeLabelDescription
loginstring

GetOs

FieldTypeLabelDescription
idint64
labelstring

GetUserByLoginIn

Data in request or getting uuid by login. If User doesnt exist - user will be creating

FieldTypeLabelDescription
loginstringEmail of target user

GetUserByLoginOut

Message for response

FieldTypeLabelDescription
uuidstringUUID of user
isNewUserboolFlag for indicate of new user

GetUserInfoByUUIDIn

Request data fo getting user info (for initiator page)

FieldTypeLabelDescription
uuidstringUUID for target user

GetUserInfoByUUIDOut

Response data for initiator page

FieldTypeLabelDescription
nicknamestring
avatarstring
namestringoptional
surnamestringoptional
birthdatestringoptional
phonestringoptional
citystringoptional
telegramstringoptional
gitstringoptional
osGetOsoptional
workstringoptional
universitystringoptional
skillsstringrepeated
hobbiesstringrepeated

GetUserWithOffsetIn

FieldTypeLabelDescription
limitint64
offsetint64
nicknamestring

GetUserWithOffsetOut

FieldTypeLabelDescription
userUserrepeated
totalint64

IsUserExistByUUIDIn

Message for request

FieldTypeLabelDescription
uuidstringUUID for target user

IsUserExistByUUIDOut

Message for response

FieldTypeLabelDescription
isExistboolFlag of indicate user exist

UpdateProfileIn

FieldTypeLabelDescription
namestring
birthdaystring
telegramstring
githubstring
os_idint64

UpdateProfileOut

FieldTypeLabelDescription
statusbool

User

FieldTypeLabelDescription
nicknamestring
uuidstring
avatar_linkstring
namestring
surnamestring

UserService

Service for friends

Method NameRequest TypeResponse TypeDescription
GetUserByLogin.GetUserByLoginIn.GetUserByLoginOutAdd friends method
IsUserExistByUUID.IsUserExistByUUIDIn.IsUserExistByUUIDOut
GetUserInfoByUUID.GetUserInfoByUUIDIn.GetUserInfoByUUIDOut
GetLoginByUUID.GetLoginByUUIDIn.GetLoginByUUIDOut
GetUserWithOffset.GetUserWithOffsetIn.GetUserWithOffsetOut
UpdateProfile.UpdateProfileIn.UpdateProfileOut

Scalar Value Types

.proto TypeNotesC++JavaPythonGoC#PHPRuby
doubledoubledoublefloatfloat64doublefloatFloat
floatfloatfloatfloatfloat32floatfloatFloat
int32Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.int32intintint32intintegerBignum or Fixnum (as required)
int64Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.int64longint/longint64longinteger/stringBignum
uint32Uses variable-length encoding.uint32intint/longuint32uintintegerBignum or Fixnum (as required)
uint64Uses variable-length encoding.uint64longint/longuint64ulonginteger/stringBignum or Fixnum (as required)
sint32Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.int32intintint32intintegerBignum or Fixnum (as required)
sint64Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.int64longint/longint64longinteger/stringBignum
fixed32Always four bytes. More efficient than uint32 if values are often greater than 2^28.uint32intintuint32uintintegerBignum or Fixnum (as required)
fixed64Always eight bytes. More efficient than uint64 if values are often greater than 2^56.uint64longint/longuint64ulonginteger/stringBignum
sfixed32Always four bytes.int32intintint32intintegerBignum or Fixnum (as required)
sfixed64Always eight bytes.int64longint/longint64longinteger/stringBignum
boolboolbooleanbooleanboolboolbooleanTrueClass/FalseClass
stringA string must always contain UTF-8 encoded or 7-bit ASCII text.stringStringstr/unicodestringstringstringString (UTF-8)
bytesMay contain any arbitrary sequence of bytes.stringByteStringstr[]byteByteStringstringString (ASCII-8BIT)

# Packages

No description provided by the author