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

[#26] object: Rename Header to ExtendedHeader

Browse source 
The naming Header obscures its semantic meaning precisely as a subclass of
the general object header. To clarify the layers of typing object headers,
this commit renames the message to ExtendedHeader. As a result, the Headers
field in the Object has been renamed to ExtendedHeaders.

Signed-off-by: Leonard Lyubich <leonard@nspcc.ru>
This commit is contained in:
Leonard Lyubich 2020-08-04 13:04:45 +03:00 committed by Stanislav Bogatyrev
parent a76f634e47
commit 2c3717bdee
2 changed files with 7 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
object/types.proto
View file

@ -16,7 +16,7 @@ message Attribute {
string Value = 2; string Value = 2;
} }
message Header { message ExtendedHeader {
oneof Value { oneof Value {
// Link to other objects // Link to other objects
Link Link = 1; Link Link = 1;
@ -112,8 +112,8 @@ message Transform {
message Object { message Object {
// SystemHeader describes system header // SystemHeader describes system header
SystemHeader SystemHeader = 1; SystemHeader SystemHeader = 1;
// Headers describes a set of an extended headers // ExtendedHeaders describes a set of an extended headers
repeated Header Headers = 2; repeated ExtendedHeader ExtendedHeaders = 2;
// Payload is an object's payload // Payload is an object's payload
bytes Payload = 3; bytes Payload = 3;
} }

8
proto-docs/object.md
View file

@ -31,7 +31,7 @@
- Messages - Messages
- [Attribute](#object.Attribute) - [Attribute](#object.Attribute)
- [CreationPoint](#object.CreationPoint) - [CreationPoint](#object.CreationPoint)
- [Header](#object.Header) - [ExtendedHeader](#object.ExtendedHeader)
- [IntegrityHeader](#object.IntegrityHeader) - [IntegrityHeader](#object.IntegrityHeader)
- [Link](#object.Link) - [Link](#object.Link)
- [Object](#object.Object) - [Object](#object.Object)
@ -385,9 +385,9 @@ Attribute groups the parameters of the object attributes.
| Epoch | [uint64](#uint64) | | Epoch is a date of creation in NeoFS epochs | | Epoch | [uint64](#uint64) | | Epoch is a date of creation in NeoFS epochs |
<a name="object.Header"></a> <a name="object.ExtendedHeader"></a>
### Message Header ### Message ExtendedHeader
@ -439,7 +439,7 @@ Attribute groups the parameters of the object attributes.
| Field | Type | Label | Description | | Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- | | ----- | ---- | ----- | ----------- |
| SystemHeader | [SystemHeader](#object.SystemHeader) | | SystemHeader describes system header | | SystemHeader | [SystemHeader](#object.SystemHeader) | | SystemHeader describes system header |
| Headers | [Header](#object.Header) | repeated | Headers describes a set of an extended headers | | ExtendedHeaders | [ExtendedHeader](#object.ExtendedHeader) | repeated | ExtendedHeaders describes a set of an extended headers |
| Payload | [bytes](#bytes) | | Payload is an object's payload | | Payload | [bytes](#bytes) | | Payload is an object's payload |