Protocol Documentation¶

Table of Contents¶

mini_vending/vendings/v1/products.proto
Scalar Value Types

mini_vending/vendings/v1/products.proto¶

AddProductToVendingRequest¶

Field	Type	Label	Description
vendingId	string
productId	int64
vendingPlaceId	int64

AddProductToVendingResponse¶

Field	Type	Label	Description
success	bool

CreateModelRequest¶

Field	Type	Label
name	string
placesCount	int64
description	string	optional

CreateModelResponse¶

Field	Type	Label	Description
modelId	int64

CreateProductRequest¶

Field	Type	Label
price	int64
name	string
description	string
imageUrl	string	optional

CreateProductResponse¶

Field	Type	Label	Description
productId	int64

CreateVendingRequest¶

Field	Type	Label	Description
modelId	int64

CreateVendingResponse¶

Field	Type	Label	Description
vendingId	string

GetModelsRequest¶

Field	Type	Label
limit	int64
offset	int64
name	string	optional

GetModelsResponse¶

Field	Type	Label	Description
models	Model	repeated
count	int64

GetProductsListRequest¶

Field	Type	Label
limit	int64
offset	int64
name	string	optional
status	string	optional
merchantId	int64	optional
orderBy	string	optional
sortOrder	string	optional

GetProductsListResponse¶

Field	Type	Label	Description
products	Product	repeated

GetProductsRequest¶

Field	Type	Label
limit	int64
offset	int64
name	string	optional

GetProductsResponse¶

Field	Type	Label	Description
products	Product	repeated
count	int64

GetVendingRequest¶

Field	Type	Label	Description
vendingId	string

GetVendingResponse¶

Field	Type	Label	Description
vending	Vending
places	VendingPlace	repeated

GetVendingsRequest¶

Field	Type	Label
limit	int64
offset	int64
vendingId	string	optional
status	string	optional
alias	string	optional
merchantId	int64	optional

GetVendingsResponse¶

Field	Type	Label	Description
vendings	Vending	repeated
count	int64

Model¶

Field	Type	Label
modelId	int64
name	string
placesCount	int64
description	string	optional

Product¶

Field	Type	Label
productId	int64
merchantId	int64
price	int64
name	string
description	string
status	string
imageUrl	string	optional
createdAt	google.protobuf.Timestamp
updatedAt	google.protobuf.Timestamp

RemoveProductFromVendingRequest¶

Field	Type	Label	Description
vendingId	string
vendingPlaceId	int64

RemoveProductFromVendingResponse¶

Field	Type	Label	Description
success	bool

UpdateModelRequest¶

Field	Type	Label
modelId	int64
name	string	optional
description	string	optional
placesCount	int64	optional

UpdateModelResponse¶

Field	Type	Label	Description
success	bool

UpdateProductRequest¶

Field	Type	Label
productId	int64
price	int64	optional
name	string	optional
description	string	optional
imageUrl	string	optional

UpdateProductResponse¶

Field	Type	Label	Description
success	bool

UpdateVendingRequest¶

Field	Type	Label
vendingId	string
status	string	optional
alias	string	optional
merchantId	int64	optional

UpdateVendingResponse¶

Field	Type	Label	Description
success	bool

Vending¶

Field	Type	Label
vendingId	string
modelId	int64
modelName	string
modelPlacesCount	int64
modelDescription	string	optional
freePlaces	int64
status	string
alias	string
merchantId	int64	optional
createdAt	google.protobuf.Timestamp
updatedAt	google.protobuf.Timestamp

VendingPlace¶

Field	Type	Label
updatedAt	google.protobuf.Timestamp
productId	int64	optional
imageUrl	string	optional
name	string	optional
description	string	optional
price	int64	optional
vendingPlaceId	int64
placeOrder	int64
free	google.protobuf.BoolValue

MerchantProductsService¶

Method Name	Request Type	Response Type
Create	CreateProductRequest	CreateProductResponse
GetList	GetProductsRequest	GetProductsResponse
Update	UpdateProductRequest	UpdateProductResponse

ModelsService¶

Method Name	Request Type	Response Type
GetList	GetModelsRequest	GetModelsResponse
Create	CreateModelRequest	CreateModelResponse
Update	UpdateModelRequest	UpdateModelResponse

ProductsService¶

Method Name	Request Type	Response Type	Description
GetList	GetProductsListRequest	GetProductsListResponse

VendingPlacesService¶

Method Name	Request Type	Response Type	Description
Add	AddProductToVendingRequest	AddProductToVendingResponse
Remove	RemoveProductFromVendingRequest	RemoveProductFromVendingResponse

VendingsService¶

Method Name	Request Type	Response Type
Create	CreateVendingRequest	CreateVendingResponse
Update	UpdateVendingRequest	UpdateVendingResponse
GetList	GetVendingsRequest	GetVendingsResponse
Get	GetVendingRequest	GetVendingResponse

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)