TrueCloudLab/frostfs-api
28
0
Fork 17
Code Issues 11 Pull requests 1 Releases Activity Actions

[#26] object: Tidy up comments

Browse source 
Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-04 23:54:26 +03:00 committed by Stanislav Bogatyrev
parent 0525786d09
commit eaad094a2c
2 changed files with 11 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
object/types.proto
View file

@ -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;
}

9
proto-docs/object.md
View file

@ -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. |
<a name="object.Object"></a>
### 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. |
<!-- end messages -->