grpc.md

Protocol Documentation

Table of Contents

• common/v1/common.proto

  • Empty

• shortener/v1/shortener.proto

  • CreateShortUrlRequest

  • CreateShortUrlResponse

  • DeleteUrlRequest

  • DeleteUrlResponse

  • ResolveKeyRequest

  • ResolveKeyResponse

  • UpdateUrlRequest

  • UpdateUrlResponse

  • ShortenerService

• user_urls/v1/user_urls.proto

  • GetUserUrlsRequest

  • GetUserUrlsResponse

  • UserUrl

  • UserUrlsService

• Scalar Value Types

Top

common/v1/common.proto

Empty

Top

shortener/v1/shortener.proto

Shortener related messages.

CreateShortUrlRequest

Field	Type	Label	Description
target_url	string		Original URL

CreateShortUrlResponse

Field	Type	Label	Description
key	string		Short key
target_url	string		Unique booking status ID

DeleteUrlRequest

Field	Type	Label	Description
key	string		Short key

DeleteUrlResponse

Field	Type	Label	Description
ok	string		response result

ResolveKeyRequest

Field	Type	Label	Description
key	string		Short key

ResolveKeyResponse

Field	Type	Label	Description
target_url	string		Original URL

UpdateUrlRequest

Field	Type	Label	Description
key	string		Short key
name	string		Description URL
is_active	bool		Key flag

UpdateUrlResponse

Field	Type	Label	Description
ok	string		response result

ShortenerService

Service for shortening logic.

Method Name	Request Type	Response Type	Description
CreateShortUrl	CreateShortUrlRequest	CreateShortUrlResponse	Used to create short key for original URL.
ResolveKey	ResolveKeyRequest	ResolveKeyResponse	Used to get original URL by short key.
UpdateUrl	UpdateUrlRequest	UpdateUrlResponse	Used to update information for URL entity by short key.
DeleteUrl	DeleteUrlRequest	DeleteUrlResponse	Used to delete short key.

Top

user_urls/v1/user_urls.proto

User urls related messages.

GetUserUrlsRequest

Field	Type	Label	Description
limit	int32
last_id	int32

GetUserUrlsResponse

Field	Type	Label	Description
items	UserUrl	repeated	UserUrl data
count	int32		Urls count

UserUrl

Field	Type	Label	Description
key	string		Short key
target_url	string		Original URL
name	string		Description URL
clicks_count	int32		Click amount
is_active	bool		Key flag
created_at	google.protobuf.Timestamp		Created time
last_used	google.protobuf.Timestamp		Last used time

UserUrlsService

Service for user urls logic.

Method Name	Request Type	Response Type	Description
GetUserUrls	GetUserUrlsRequest	GetUserUrlsResponse	Used to get all user urls.

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)