ironbee/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Pull requests Activity

[#28] storagegroup: Rewrite field comments

Browse source 
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-05 11:48:26 +03:00 committed by Stanislav Bogatyrev
parent 487b84e614
commit d349faa602
2 changed files with 9 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
proto-docs/storagegroup.md
View file

@ -25,13 +25,14 @@
<a name="storagegroup.StorageGroup"></a> <a name="storagegroup.StorageGroup"></a>
### Message StorageGroup ### Message StorageGroup
StorageGroup groups the information about the NeoFS storage group.
The storage group consists of objects from single container.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| ValidationDataSize | [uint64](#uint64) | | ValidationDataSize is size of the all object's payloads included into storage group | | ValidationDataSize | [uint64](#uint64) | | ValidationDataSize carries the total size of the payloads of the storage group members. |
| ValidationHash | [bytes](#bytes) | | ValidationHash is homomorphic hash of all object's payloads included into storage group | | ValidationHash | [bytes](#bytes) | | ValidationHash carries homomorphic hash from the concatenation of the payloads of the storage group members. The order of concatenation is the same as the order of the members in the Members field. |
| ExpirationEpoch | [uint64](#uint64) | | ExpirationEpoch carries last NeoFS epoch number of the storage group lifetime. | | ExpirationEpoch | [uint64](#uint64) | | ExpirationEpoch carries last NeoFS epoch number of the storage group lifetime. |
| Members | [refs.ObjectID](#refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. | | Members | [refs.ObjectID](#refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. |

7
storagegroup/types.proto
View file

@ -5,10 +5,13 @@ option csharp_namespace = "NeoFS.API.StorageGroup";
import "refs/types.proto"; import "refs/types.proto";
// StorageGroup groups the information about the NeoFS storage group.
// The storage group consists of objects from single container.
message StorageGroup { message StorageGroup {
// ValidationDataSize is size of the all object's payloads included into storage group // ValidationDataSize carries the total size of the payloads of the storage group members.
uint64 ValidationDataSize = 1; uint64 ValidationDataSize = 1;
// ValidationHash is homomorphic hash of all object's payloads included into storage group // ValidationHash carries homomorphic hash from the concatenation of the payloads of the storage group members.
// The order of concatenation is the same as the order of the members in the Members field.
bytes ValidationHash = 2; bytes ValidationHash = 2;
// ExpirationEpoch carries last NeoFS epoch number of the storage group lifetime. // ExpirationEpoch carries last NeoFS epoch number of the storage group lifetime.