forked from TrueCloudLab/frostfs-api
[#33] decimal: Move Decimal to accounting
Move Decimal message definition to accounting package since it is only used there. Package decimal is completely removed from the repository. Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich
Stanislav Bogatyrev
parent
0f478ffaa6
commit
e6fce062df
4 changed files with 24 additions and 77 deletions
|
|
@ -5,7 +5,6 @@ option csharp_namespace = "NeoFS.API.Accounting";
|
|||
|
||||
import "service/meta.proto";
|
||||
import "service/verify.proto";
|
||||
import "decimal/decimal.proto";
|
||||
import "refs/types.proto";
|
||||
|
||||
// Accounting is a service that provides access for accounting balance
|
||||
|
|
@ -24,7 +23,16 @@ message BalanceRequest {
|
|||
service.RequestVerificationHeader Verify = 99;
|
||||
}
|
||||
|
||||
// Decimal represents the decimal numbers.
|
||||
message Decimal {
|
||||
// Value carries number value.
|
||||
int64 Value = 1;
|
||||
|
||||
// Precision carries value precision.
|
||||
uint32 Precision = 2;
|
||||
}
|
||||
|
||||
message BalanceResponse {
|
||||
// Balance contains current account balance state
|
||||
decimal.Decimal Balance = 1;
|
||||
Decimal Balance = 1;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1,13 +0,0 @@
|
|||
syntax = "proto3";
|
||||
package decimal;
|
||||
option go_package = "github.com/nspcc-dev/neofs-api-go/decimal";
|
||||
option csharp_namespace = "NeoFS.API.Decimal";
|
||||
|
||||
// Decimal represents the decimal numbers.
|
||||
message Decimal {
|
||||
// Value carries number value.
|
||||
int64 Value = 1;
|
||||
|
||||
// Precision carries value precision.
|
||||
uint32 Precision = 2;
|
||||
}
|
||||
|
|
@ -10,6 +10,7 @@
|
|||
- Messages
|
||||
- [BalanceRequest](#accounting.BalanceRequest)
|
||||
- [BalanceResponse](#accounting.BalanceResponse)
|
||||
- [Decimal](#accounting.Decimal)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
|
@ -66,7 +67,19 @@ Balance returns current balance status of the NeoFS user
|
|||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Balance | [decimal.Decimal](#decimal.Decimal) | | Balance contains current account balance state |
|
||||
| Balance | [Decimal](#accounting.Decimal) | | Balance contains current account balance state |
|
||||
|
||||
|
||||
<a name="accounting.Decimal"></a>
|
||||
|
||||
### Message Decimal
|
||||
Decimal represents the decimal numbers.
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Value | [int64](#int64) | | Value carries number value. |
|
||||
| Precision | [uint32](#uint32) | | Precision carries value precision. |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
|
|
|
|||
|
|
@ -1,61 +0,0 @@
|
|||
# Protocol Documentation
|
||||
<a name="top"></a>
|
||||
|
||||
## Table of Contents
|
||||
|
||||
- [decimal/decimal.proto](#decimal/decimal.proto)
|
||||
|
||||
- Messages
|
||||
- [Decimal](#decimal.Decimal)
|
||||
|
||||
|
||||
- [Scalar Value Types](#scalar-value-types)
|
||||
|
||||
|
||||
|
||||
<a name="decimal/decimal.proto"></a>
|
||||
<p align="right"><a href="#top">Top</a></p>
|
||||
|
||||
## decimal/decimal.proto
|
||||
|
||||
|
||||
<!-- end services -->
|
||||
|
||||
|
||||
<a name="decimal.Decimal"></a>
|
||||
|
||||
### Message Decimal
|
||||
Decimal is a structure used for representation of assets amount
|
||||
|
||||
|
||||
| Field | Type | Label | Description |
|
||||
| ----- | ---- | ----- | ----------- |
|
||||
| Value | [int64](#int64) | | Value is value number |
|
||||
| Precision | [uint32](#uint32) | | Precision is precision number |
|
||||
|
||||
<!-- end messages -->
|
||||
|
||||
<!-- end enums -->
|
||||
|
||||
|
||||
|
||||
## Scalar Value Types
|
||||
|
||||
| .proto Type | Notes | C++ Type | Java Type | Python Type |
|
||||
| ----------- | ----- | -------- | --------- | ----------- |
|
||||
| <a name="double" /> double | | double | double | float |
|
||||
| <a name="float" /> float | | float | float | float |
|
||||
| <a name="int32" /> 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 |
|
||||
| <a name="int64" /> 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 |
|
||||
| <a name="uint32" /> uint32 | Uses variable-length encoding. | uint32 | int | int/long |
|
||||
| <a name="uint64" /> uint64 | Uses variable-length encoding. | uint64 | long | int/long |
|
||||
| <a name="sint32" /> sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int |
|
||||
| <a name="sint64" /> sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long |
|
||||
| <a name="fixed32" /> fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int |
|
||||
| <a name="fixed64" /> fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long |
|
||||
| <a name="sfixed32" /> sfixed32 | Always four bytes. | int32 | int | int |
|
||||
| <a name="sfixed64" /> sfixed64 | Always eight bytes. | int64 | long | int/long |
|
||||
| <a name="bool" /> bool | | bool | boolean | boolean |
|
||||
| <a name="string" /> string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode |
|
||||
| <a name="bytes" /> bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str |
|
||||
|
||||
Loading…
Reference in a new issue