realloc/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity

[#45] Fix linter errors

Browse source 
- Changed package names adding version
- Added documentation descriptions (sometimes useless) for all fields
- Changed enum format
- Made SessionToken and BearerToken field names more clear

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-08-13 00:43:51 +03:00 • committed by Alex Vanin
parent 35d1d34ee0
commit 42e35fefff
13 changed files with 393 additions and 224 deletions
Download patch file Download diff file Expand all files Collapse all files

46
object/types.proto
View file

@ -1,9 +1,9 @@
syntax = "proto3";
package object;
package neo.fs.v2.object;
option go_package = "github.com/nspcc-dev/neofs-api-go/object";
option csharp_namespace = "NeoFS.API.Object";
option go_package = "github.com/nspcc-dev/neofs-api-go/v2/object;object";
option csharp_namespace = "NeoFS.API.v2.Object";
import "refs/types.proto";
import "service/meta.proto";
@ -13,33 +13,45 @@ import "service/verify.proto";
enum ObjectType {
// Just a normal object
REGULAR = 0;
// Used internally to identify deleted objects
TOMBSTONE = 1;
// Identifies that the object holds StorageGroup information
STORAGE_GROUP = 2;
}
// Object Headers
message Header {
// Object's container
refs.ContainerID container_id = 1;
neo.fs.v2.refs.ContainerID container_id = 1;
// Object's owner
refs.OwnerID owner_id = 2;
neo.fs.v2.refs.OwnerID owner_id = 2;
// Epoch when the object was created
uint64 creation_epoch = 3;
// Object format version.
// Effectively the version of API library used to create particular object
service.Version version = 4;
neo.fs.v2.service.Version version = 4;
// Size of payload in bytes.
// 0xFFFFFFFFFFFFFFFF means `payload_length` is unknown
uint64 payload_length = 5;
// Hash of payload bytes
bytes payload_hash = 6;
// Special object type
ObjectType object_type = 7;
// Homomorphic hash of the object payload.
bytes homomorphic_hash = 8;
// Session token, if it was used during Object creation.
// Need it to verify integrity and authenticity out of Request scope.
service.SessionToken session_token = 9;
neo.fs.v2.service.SessionToken session_token = 9;
// Attribute groups the user-defined Key-Value pairs attached to the object
message Attribute {
@ -48,6 +60,7 @@ message Header {
// string value of the object attribute
string value = 2;
}
// User-defined object attributes
repeated Attribute attributes = 10;
// Information about spawning the objects through a payload splitting.
@ -55,15 +68,19 @@ message Header {
// Identifier of the origin object.
// Parent and children objects must be within the same container.
// Parent object_id is known only to the minor child.
refs.ObjectID parent = 1;
neo.fs.v2.refs.ObjectID parent = 1;
// Previous carries identifier of the left split neighbor.
refs.ObjectID previous = 2;
neo.fs.v2.refs.ObjectID previous = 2;
// `signature` field of the parent object. Used to reconstruct parent.
service.Signature parent_signature = 3;
neo.fs.v2.service.Signature parent_signature = 3;
// `header` field of the parent object. Used to reconstruct parent.
Header parent_header = 4;
// Children carries list of identifiers of the objects generated by splitting the current.
repeated refs.ObjectID children = 5;
repeated neo.fs.v2.refs.ObjectID children = 5;
}
// Position of the object in the split hierarchy.
Split split = 11;
@ -75,11 +92,14 @@ message Object {
// Object is content-addressed. It means id will change if header or payload
// changes. It's calculated as a hash of header field, which contains hash of
// object's payload
refs.ObjectID object_id = 1;
neo.fs.v2.refs.ObjectID object_id = 1;
// Signed object_id
service.Signature signature = 2;
neo.fs.v2.service.Signature signature = 2;
// Object metadata headers
Header header = 3;
// Payload bytes.
bytes payload = 4;
}