frostfs-api/accounting/service.proto

45 lines
1.2 KiB
Protocol Buffer
Raw Normal View History

2020-01-30 11:41:24 +00:00
syntax = "proto3";
2020-01-30 11:41:24 +00:00
package accounting;
2020-03-31 06:58:22 +00:00
option go_package = "github.com/nspcc-dev/neofs-api-go/accounting";
2020-02-05 12:14:39 +00:00
option csharp_namespace = "NeoFS.API.Accounting";
2020-01-30 11:41:24 +00:00
import "refs/types.proto";
2020-01-30 11:41:24 +00:00
// The service provides methods for obtaining information
// about the account balance in NeoFS system.
2020-01-30 11:41:24 +00:00
service Accounting {
// Returns the amount of funds for the requested NeoFS account.
rpc Balance (BalanceRequest) returns (BalanceResponse);
2020-01-30 11:41:24 +00:00
}
// Message defines the request body of Balance method.
//
// To indicate the account for which the balance is requested, it's identifier
// is used.
//
// To gain access to the requested information, the request body must be formed
// according to the requirements from the system specification.
2020-01-30 11:41:24 +00:00
message BalanceRequest {
// Carries user identifier in NeoFS system for which the balance is requested.
refs.OwnerID owner_id = 1;
2020-01-30 11:41:24 +00:00
}
// Decimal represents the decimal numbers.
message Decimal {
// value carries number value.
int64 value = 1;
// precision carries value precision.
uint32 precision = 2;
}
// Message defines the response body of Balance method.
//
// The amount of funds is calculated in decimal numbers.
2020-01-30 11:41:24 +00:00
message BalanceResponse {
// Carries the amount of funds on the account.
Decimal balance = 1;
2020-01-30 11:41:24 +00:00
}