From eaad094a2c6b4d673c0416da02858d67104f8de7 Mon Sep 17 00:00:00 2001 From: Leonard Lyubich Date: Tue, 4 Aug 2020 23:54:26 +0300 Subject: [PATCH] [#26] object: Tidy up comments Signed-off-by: Leonard Lyubich --- object/types.proto | 9 ++++++--- proto-docs/object.md | 9 +++++---- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/object/types.proto b/object/types.proto index bdbf17e..0a5c688 100644 --- a/object/types.proto +++ b/object/types.proto @@ -12,12 +12,13 @@ message Header { // System groups mandatory information about the object. // Message fields are presented in all NeoFS objects. message System { - // PayloadLength is an object payload length + // PayloadLength carries length of the object payload. + // Each object has a fixed payload length since it's immutable. uint64 PayloadLength = 1; // Address carries object address in the NeoFS system. // It encapsulates the object and the container identifiers. refs.Address Address = 2; - // OwnerID is a wallet address + // OwnerID carries identifier the object owner in a binary format. bytes OwnerID = 3; } // System carries the main part of the header. @@ -102,9 +103,11 @@ message Header { Extended extended = 2; } +// Object groups the information about the NeoFS object. +// It consists of payload data with additional service information. message Object { // Header carries the object header. Header Header = 1; - // Payload is an object's payload + // Payload carries the object payload bytes. bytes Payload = 2; } diff --git a/proto-docs/object.md b/proto-docs/object.md index 59d8548..864d852 100644 --- a/proto-docs/object.md +++ b/proto-docs/object.md @@ -448,21 +448,22 @@ Message fields are presented in all NeoFS objects. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| PayloadLength | [uint64](#uint64) | | PayloadLength is an object payload length | +| PayloadLength | [uint64](#uint64) | | PayloadLength carries length of the object payload. Each object has a fixed payload length since it's immutable. | | Address | [refs.Address](#refs.Address) | | Address carries object address in the NeoFS system. It encapsulates the object and the container identifiers. | -| OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | +| OwnerID | [bytes](#bytes) | | OwnerID carries identifier the object owner in a binary format. | ### Message Object - +Object groups the information about the NeoFS object. +It consists of payload data with additional service information. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Header | [Header](#object.Header) | | Header carries the object header. | -| Payload | [bytes](#bytes) | | Payload is an object's payload | +| Payload | [bytes](#bytes) | | Payload carries the object payload bytes. |