From d349faa60266c73f8b680fafe60d03a5661714a1 Mon Sep 17 00:00:00 2001 From: Leonard Lyubich Date: Wed, 5 Aug 2020 11:48:26 +0300 Subject: [PATCH] [#28] storagegroup: Rewrite field comments Signed-off-by: Leonard Lyubich --- proto-docs/storagegroup.md | 7 ++++--- storagegroup/types.proto | 7 +++++-- 2 files changed, 9 insertions(+), 5 deletions(-) diff --git a/proto-docs/storagegroup.md b/proto-docs/storagegroup.md index e1d27ae..c209b86 100644 --- a/proto-docs/storagegroup.md +++ b/proto-docs/storagegroup.md @@ -25,13 +25,14 @@ ### Message StorageGroup - +StorageGroup groups the information about the NeoFS storage group. +The storage group consists of objects from single container. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| ValidationDataSize | [uint64](#uint64) | | ValidationDataSize is size of the all object's payloads included into storage group | -| ValidationHash | [bytes](#bytes) | | ValidationHash is homomorphic hash of 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 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. | | Members | [refs.ObjectID](#refs.ObjectID) | repeated | Members carries the list of identifiers of the object storage group members. The list is strictly ordered. | diff --git a/storagegroup/types.proto b/storagegroup/types.proto index 0848ac0..af93a5f 100644 --- a/storagegroup/types.proto +++ b/storagegroup/types.proto @@ -5,10 +5,13 @@ option csharp_namespace = "NeoFS.API.StorageGroup"; import "refs/types.proto"; +// StorageGroup groups the information about the NeoFS storage group. +// The storage group consists of objects from single container. 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; - // 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; // ExpirationEpoch carries last NeoFS epoch number of the storage group lifetime.