From 15b997bdb51b2e3dbafab0a10e4b7c8c3b1f8b37 Mon Sep 17 00:00:00 2001 From: Evgeniy Kulikov Date: Thu, 21 Nov 2019 10:26:01 +0300 Subject: [PATCH 1/4] docs: update proto doc comments to satisfy go-doc comment --- accounting/withdraw.proto | 4 +- container/types.proto | 12 ++-- object/service.proto | 117 ++++++++++++++++++++----------- object/types.proto | 141 +++++++++++++++++++++++++------------- query/types.proto | 3 +- refs/types.proto | 2 +- session/service.proto | 17 +++-- session/types.proto | 16 ++--- 8 files changed, 201 insertions(+), 111 deletions(-) diff --git a/accounting/withdraw.proto b/accounting/withdraw.proto index 33ce402f..8e10ef99 100644 --- a/accounting/withdraw.proto +++ b/accounting/withdraw.proto @@ -42,7 +42,7 @@ message GetRequest { } message GetResponse { - // Item is cheque with meta information + // Withdraw is cheque with meta information Item Withdraw = 1; } @@ -73,7 +73,7 @@ message ListRequest { } message ListResponse { - // Item is a set of cheques with meta information + // Items is a set of cheques with meta information repeated Item Items = 1; } diff --git a/container/types.proto b/container/types.proto index efcaee82..a601edd0 100644 --- a/container/types.proto +++ b/container/types.proto @@ -9,8 +9,12 @@ option (gogoproto.stable_marshaler_all) = true; // The Container service definition. message Container { - bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // OwnerID is a wallet address. - bytes Salt = 2 [(gogoproto.customtype) = "UUID", (gogoproto.nullable) = false]; // Salt is a nonce for unique container id calculation. - uint64 Capacity = 3; // Capacity defines amount of data that can be stored in the container (doesn't used for now). - netmap.PlacementRule Rules = 4 [(gogoproto.nullable) = false]; // Rules define storage policy for the object inside the container. + // OwnerID is a wallet address. + bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; + // Salt is a nonce for unique container id calculation. + bytes Salt = 2 [(gogoproto.customtype) = "UUID", (gogoproto.nullable) = false]; + // Capacity defines amount of data that can be stored in the container (doesn't used for now). + uint64 Capacity = 3; + // Rules define storage policy for the object inside the container. + netmap.PlacementRule Rules = 4 [(gogoproto.nullable) = false]; } diff --git a/object/service.proto b/object/service.proto index 6f13d55c..5edf9355 100644 --- a/object/service.proto +++ b/object/service.proto @@ -52,41 +52,58 @@ service Service { } message GetRequest { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - refs.Address Address = 2 [(gogoproto.nullable) = false]; // Address of object (container id + object id) - uint32 TTL = 3; // TTL must be larger than zero, it decreased in every neofs-node + // Epoch is set by user to 0, node set epoch to the actual value + uint64 Epoch = 1; + // Address of object (container id + object id) + refs.Address Address = 2 [(gogoproto.nullable) = false]; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 3; } message GetResponse { oneof R { - Object object = 1; // Object header and some payload - bytes Chunk = 2; // Chunk of remaining payload + // Object header and some payload + Object object = 1; + // Chunk of remaining payload + bytes Chunk = 2; } } message PutRequest { message PutHeader { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - Object Object = 2; // Object with at least container id and owner id fields - uint32 TTL = 3; // TTL must be larger than zero, it decreased in every neofs-node - session.Token Token = 4; // Token with session public key and user's signature + // Epoch is set by user to 0, node set epoch to the actual value + uint64 Epoch = 1; + // Object with at least container id and owner id fields + Object Object = 2; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 3; + // Token with session public key and user's signature + session.Token Token = 4; } oneof R { - PutHeader Header = 1; // Header should be the first message in the stream - bytes Chunk = 2; // Chunk should be a remaining message in stream should be chunks + // Header should be the first message in the stream + PutHeader Header = 1; + // Chunk should be a remaining message in stream should be chunks + bytes Chunk = 2; } } message PutResponse { - refs.Address Address = 1 [(gogoproto.nullable) = false]; // Address of object (container id + object id) + // Address of object (container id + object id) + refs.Address Address = 1 [(gogoproto.nullable) = false]; } message DeleteRequest { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - refs.Address Address = 2 [(gogoproto.nullable) = false]; // Address of object (container id + object id) - bytes OwnerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "OwnerID"]; // OwnerID is a wallet address - uint32 TTL = 4; // TTL must be larger than zero, it decreased in every neofs-node - session.Token Token = 5; // Token with session public key and user's signature + // Epoch is set by user to 0, node set epoch to the actual value + uint64 Epoch = 1; + // Address of object (container id + object id) + refs.Address Address = 2 [(gogoproto.nullable) = false]; + // OwnerID is a wallet address + bytes OwnerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "OwnerID"]; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 4; + // Token with session public key and user's signature + session.Token Token = 5; } // DeleteResponse is empty because we cannot guarantee permanent object removal @@ -94,47 +111,69 @@ message DeleteRequest { message DeleteResponse {} message HeadRequest { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - refs.Address Address = 2 [(gogoproto.nullable) = false, (gogoproto.customtype) = "Address"]; // Address of object (container id + object id) - bool FullHeaders = 3; // FullHeaders can be set true for extended headers in the object - uint32 TTL = 4; // TTL must be larger than zero, it decreased in every neofs-node + // Epoch should be empty on user side, node sets epoch to the actual value + uint64 Epoch = 1; + // Address of object (container id + object id) + refs.Address Address = 2 [(gogoproto.nullable) = false, (gogoproto.customtype) = "Address"]; + // FullHeaders can be set true for extended headers in the object + bool FullHeaders = 3; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 4; } message HeadResponse { - Object Object = 1; // Object without payload + // Object without payload + Object Object = 1; } message SearchRequest { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - uint32 Version = 2; // Version of search query format - bytes ContainerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "CID"]; // ContainerID for searching the object - bytes Query = 4; // Query in the binary serialized format - uint32 TTL = 5; // TTL must be larger than zero, it decreased in every neofs-node + // Epoch is set by user to 0, node set epoch to the actual value + uint64 Epoch = 1; + // Version of search query format + uint32 Version = 2; + // ContainerID for searching the object + bytes ContainerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "CID"]; + // Query in the binary serialized format + bytes Query = 4; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 5; } message SearchResponse { - repeated refs.Address Addresses = 1 [(gogoproto.nullable) = false]; // Addresses of found objects + // Addresses of found objects + repeated refs.Address Addresses = 1 [(gogoproto.nullable) = false]; } message GetRangeRequest { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - refs.Address Address = 2 [(gogoproto.nullable) = false]; // Address of object (container id + object id) - repeated Range Ranges = 3 [(gogoproto.nullable) = false]; // Ranges of object's payload to return - uint32 TTL = 4; // TTL must be larger than zero, it decreased in every neofs-node + // Epoch is set by user to 0, node set epoch to the actual value + uint64 Epoch = 1; + // Address of object (container id + object id) + refs.Address Address = 2 [(gogoproto.nullable) = false]; + // Ranges of object's payload to return + repeated Range Ranges = 3 [(gogoproto.nullable) = false]; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 4; } message GetRangeResponse { - repeated bytes Fragments = 1; // Fragments of object's payload + // Fragments of object's payload + repeated bytes Fragments = 1; } message GetRangeHashRequest { - uint64 Epoch = 1; // Epoch is set by user to 0, node set epoch to the actual value - refs.Address Address = 2 [(gogoproto.nullable) = false]; // Address of object (container id + object id) - repeated Range Ranges = 3 [(gogoproto.nullable) = false]; // Ranges of object's payload to calculate homomorphic hash - bytes Salt = 4; // Salt is used to XOR object's payload ranges before hashing, it can be nil - uint32 TTL = 5; // TTL must be larger than zero, it decreased in every neofs-node + // Epoch is set by user to 0, node set epoch to the actual value + uint64 Epoch = 1; + // Address of object (container id + object id) + refs.Address Address = 2 [(gogoproto.nullable) = false]; + // Ranges of object's payload to calculate homomorphic hash + repeated Range Ranges = 3 [(gogoproto.nullable) = false]; + // Salt is used to XOR object's payload ranges before hashing, it can be nil + bytes Salt = 4; + // TTL must be larger than zero, it decreased in every neofs-node + uint32 TTL = 5; } message GetRangeHashResponse { - repeated bytes Hashes = 1 [(gogoproto.customtype) = "Hash", (gogoproto.nullable) = false]; // Homomorphic hashes of all ranges + // Hashes is a homomorphic hashes of all ranges + repeated bytes Hashes = 1 [(gogoproto.customtype) = "Hash", (gogoproto.nullable) = false]; } diff --git a/object/types.proto b/object/types.proto index 30e468ec..f3313a3b 100644 --- a/object/types.proto +++ b/object/types.proto @@ -9,97 +9,144 @@ import "github.com/gogo/protobuf/gogoproto/gogo.proto"; option (gogoproto.stable_marshaler_all) = true; message Range { - uint64 Offset = 1; // Offset of the data range - uint64 Length = 2; // Length of the data range + // Offset of the data range + uint64 Offset = 1; + // Length of the data range + uint64 Length = 2; } message UserHeader { - string Key = 1; // Key of the user's header - string Value = 2; // Value of the user's header + // Key of the user's header + string Key = 1; + // Value of the user's header + string Value = 2; } message Header { oneof Value { - Link Link = 1; // Link to other objects - refs.Address Redirect = 2; // RedirectNot used yet - UserHeader UserHeader = 3; // UserHeader defined by user - Transform Transform = 4; // Transform defines transform operation (e.g. payload split) - Tombstone Tombstone = 5; // Tombstone header that set up in deleted objects - session.VerificationHeader Verify = 6; // Verify header that contains session public key and user's signature - bytes HomoHash = 7 [(gogoproto.customtype) = "Hash"]; // Homomorphic hash of original object payload - bytes PayloadChecksum = 8; // PayloadChecksum of actual object's payload - IntegrityHeader Integrity = 9; // Integrity header with checksum of all above headers in the object - StorageGroup StorageGroup = 10; // StorageGroup contains meta information for the data audit + // Link to other objects + Link Link = 1; + // Redirect not used yet + refs.Address Redirect = 2; + // UserHeader is a set of KV headers defined by user + UserHeader UserHeader = 3; + // Transform defines transform operation (e.g. payload split) + Transform Transform = 4; + // Tombstone header that set up in deleted objects + Tombstone Tombstone = 5; + // Verify header that contains session public key and user's signature + session.VerificationHeader Verify = 6; + // HomoHash is a homomorphic hash of original object payload + bytes HomoHash = 7 [(gogoproto.customtype) = "Hash"]; + // PayloadChecksum of actual object's payload + bytes PayloadChecksum = 8; + // Integrity header with checksum of all above headers in the object + IntegrityHeader Integrity = 9; + // StorageGroup contains meta information for the data audit + StorageGroup StorageGroup = 10; } } message Tombstone { - uint64 Epoch = 1; // Epoch when tombstone was created + // Epoch when tombstone was created + uint64 Epoch = 1; } message SystemHeader { - uint64 Version = 1; // Version of the object structure - uint64 PayloadLength = 2; // Object payload length + // Version of the object structure + uint64 Version = 1; + // PayloadLength is an object payload length + uint64 PayloadLength = 2; - bytes ID = 3 [(gogoproto.customtype) = "ID", (gogoproto.nullable) = false]; // ObjectID is a UUID - bytes OwnerID = 4 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // OwnerID is a wallet address - bytes CID = 5 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false]; // ContainerID is a SHA256 hash of the container structure - CreationPoint CreatedAt = 6 [(gogoproto.nullable) = false]; // Timestamp of object creation + // ID is an object identifier, is a valid UUIDv4 + bytes ID = 3 [(gogoproto.customtype) = "ID", (gogoproto.nullable) = false]; + // OwnerID is a wallet address + bytes OwnerID = 4 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; + // CID is a SHA256 hash of the container structure (container identifier) + bytes CID = 5 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false]; + // CreatedAt is a timestamp of object creation + CreationPoint CreatedAt = 6 [(gogoproto.nullable) = false]; } message CreationPoint { - int64 UnixTime = 1; // Date of creation in unixtime format - uint64 Epoch = 2; // Date of creation in NeoFS epochs + // UnixTime is a date of creation in unixtime format + int64 UnixTime = 1; + // Epoch is a date of creation in NeoFS epochs + uint64 Epoch = 2; } message IntegrityHeader { - bytes HeadersChecksum = 1; // Checksum of all above headers in the object - bytes ChecksumSignature = 2; // User's signature of checksum to verify if it is correct + // HeadersChecksum is a checksum of all above headers in the object + bytes HeadersChecksum = 1; + // ChecksumSignature is an user's signature of checksum to verify if it is correct + bytes ChecksumSignature = 2; } message Link { enum Type { Unknown = 0; - Parent = 1; // Parent object created during object transformation - Previous = 2; // Previous object in the linked list created during object transformation - Next = 3; // Next object in the linked list created during object transformation - Child = 4; // Child object created during object transformation - StorageGroup = 5; // Object that included into this storage group + // Parent object created during object transformation + Parent = 1; + // Previous object in the linked list created during object transformation + Previous = 2; + // Next object in the linked list created during object transformation + Next = 3; + // Child object created during object transformation + Child = 4; + // Object that included into this storage group + StorageGroup = 5; } - Type type = 1; // Link type - bytes ID = 2 [(gogoproto.customtype) = "ID", (gogoproto.nullable) = false]; // Object id + // Type of link + Type type = 1; + // ID is an object identifier, is a valid UUIDv4 + bytes ID = 2 [(gogoproto.customtype) = "ID", (gogoproto.nullable) = false]; } message Transform { enum Type { Unknown = 0; - Split = 1; // Object created after payload split - Sign = 2; // Object created after re-signing (doesn't used) - Mould = 3; // Object created after filling missing headers in the object + // Split sets when object created after payload split + Split = 1; + // Sign sets when object created after re-signing (doesn't used) + Sign = 2; + // Mould sets when object created after filling missing headers in the object + Mould = 3; } - Type type = 1; // Type of object transformation + // Type of object transformation + Type type = 1; } message Object { - SystemHeader SystemHeader = 1 [(gogoproto.nullable) = false]; // System header - repeated Header Headers = 2 [(gogoproto.nullable) = false]; // Extended headers - bytes Payload = 3; // Object's payload + // SystemHeader describes system header + SystemHeader SystemHeader = 1 [(gogoproto.nullable) = false]; + // Headers describes a set of an extended headers + repeated Header Headers = 2 [(gogoproto.nullable) = false]; + // Payload is an object's payload + bytes Payload = 3; } message StorageGroup { - uint64 ValidationDataSize = 1; // Size of the all object's payloads included into storage group - bytes ValidationHash = 2 [(gogoproto.customtype) = "Hash", (gogoproto.nullable) = false]; // Homomorphic hash of all object's payloads included into storage group + // ValidationDataSize is size of the all object's payloads included into storage group + uint64 ValidationDataSize = 1; + // ValidationHash is homomorphic hash of all object's payloads included into storage group + bytes ValidationHash = 2 [(gogoproto.customtype) = "Hash", (gogoproto.nullable) = false]; message Lifetime { enum Unit { - Unlimited = 0; // Storage group always valid - NeoFSEpoch = 1; // Storage group is valid until lifetime NeoFS epoch - UnixTime = 2; // Storage group is valid until lifetime unix timestamp + // Unlimited set if storage group always valid + Unlimited = 0; + // NeoFSEpoch set if storage group is valid until lifetime NeoFS epoch + NeoFSEpoch = 1; + // UnixTime set if storage group is valid until lifetime unix timestamp + UnixTime = 2; } - Unit unit = 1 [(gogoproto.customname) = "Unit"]; // Lifetime type - int64 Value = 2; // Lifetime value + // Unit is lifetime type + Unit unit = 1 [(gogoproto.customname) = "Unit"]; + // Value for lifetime + int64 Value = 2; } - Lifetime lifetime = 3 [(gogoproto.customname) = "Lifetime"]; // Time until storage group is valid + // Lifetime is time until storage group is valid + Lifetime lifetime = 3 [(gogoproto.customname) = "Lifetime"]; } diff --git a/query/types.proto b/query/types.proto index 884a6bd1..6eaed5da 100644 --- a/query/types.proto +++ b/query/types.proto @@ -9,9 +9,10 @@ option (gogoproto.stable_marshaler_all) = true; message Filter { option (gogoproto.goproto_stringer) = false; - // Type can be Exact or Regex enum Type { + // Exact sets when value of filter should be equal to the header value Exact = 0; + // Regex sets when value of filter should match the header value by the regular expression Regex = 1; } diff --git a/refs/types.proto b/refs/types.proto index 15355ae0..8c7d2ebf 100644 --- a/refs/types.proto +++ b/refs/types.proto @@ -11,7 +11,7 @@ option (gogoproto.goproto_stringer_all) = false; // Address of object (container id + object id) message Address { - // ObjectID is an object identifier + // ObjectID is an object identifier, valid UUIDv4 represented in bytes bytes ObjectID = 1[(gogoproto.customtype) = "ObjectID", (gogoproto.nullable) = false]; // CID is container identifier bytes CID = 2[(gogoproto.customtype) = "CID", (gogoproto.nullable) = false]; diff --git a/session/service.proto b/session/service.proto index 484425bc..4b37aafb 100644 --- a/session/service.proto +++ b/session/service.proto @@ -9,17 +9,16 @@ option (gogoproto.stable_marshaler_all) = true; service Session { - // Open a trusted session to manipulate an object. In order to put or - // delete object client have to obtain session token with trusted node. - // Trusted node will modify client's object (add missing headers, checksums, - // homomorphic hash) and sign id with session key. Session is established - // during 4-step handshake in one gRPC stream - + // Create is a method that used to open a trusted session to manipulate + // an object. In order to put or delete object client have to obtain session + // token with trusted node. Trusted node will modify client's object + // (add missing headers, checksums, homomorphic hash) and sign id with + // session key. Session is established during 4-step handshake in one gRPC stream + // // - First client stream message SHOULD BE type of `CreateRequest_Init`. // - First server stream message SHOULD BE type of `CreateResponse_Unsigned`. // - Second client stream message SHOULD BE type of `CreateRequest_Signed`. // - Second server stream message SHOULD BE type of `CreateResponse_Result`. - rpc Create (stream CreateRequest) returns (stream CreateResponse); } @@ -27,7 +26,7 @@ service Session { message CreateRequest { // Message should be one of oneof Message { - // Message to init session opening. Carry: + // Init is a message to initialize session opening. Carry: // owner of manipulation object; // ID of manipulation object; // token lifetime bounds. @@ -41,7 +40,7 @@ message CreateResponse { oneof Message { // Unsigned token with token ID and session public key generated on server side session.Token Unsigned = 1; - // Resulting token which can be used for object placing through an trusted intermediary + // Result is a resulting token which can be used for object placing through an trusted intermediary session.Token Result = 2; } } diff --git a/session/types.proto b/session/types.proto index bf804bf4..1ade791c 100644 --- a/session/types.proto +++ b/session/types.proto @@ -7,9 +7,9 @@ import "github.com/gogo/protobuf/gogoproto/gogo.proto"; option (gogoproto.stable_marshaler_all) = true; message VerificationHeader { - // Session public key + // PublicKey is a session public key bytes PublicKey = 1; - // Session public key signature. Signed by trusted side + // KeySignature is a session public key signature. Signed by trusted side bytes KeySignature = 2; } @@ -17,16 +17,16 @@ message VerificationHeader { message Token { // Header carries verification data of session key VerificationHeader Header = 1 [(gogoproto.nullable) = false]; - // Owner of manipulation object + // OwnerID is an owner of manipulation object bytes OwnerID = 2 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; - // Initial epoch of token lifetime + // FirstEpoch is an initial epoch of token lifetime uint64 FirstEpoch = 3; - // Last epoch of token lifetime + // LastEpoch is a last epoch of token lifetime uint64 LastEpoch = 4; - // ID of manipulation object + // ObjectID is an object identifier of manipulation object repeated bytes ObjectID = 5 [(gogoproto.customtype) = "ObjectID", (gogoproto.nullable) = false]; - // Token signature. Signed by owner of manipulation object + // Signature is a token signature, signed by owner of manipulation object bytes Signature = 6; - // Token ID (UUID) + // ID is a token identifier. valid UUIDv4 represented in bytes bytes ID = 7 [(gogoproto.customtype) = "TokenID", (gogoproto.nullable) = false]; } From 3d445aeb0b2e1fc71e06e66f22b67bd4fa918970 Mon Sep 17 00:00:00 2001 From: Evgeniy Kulikov Date: Thu, 21 Nov 2019 10:32:07 +0300 Subject: [PATCH 2/4] docs: add deprecation notice for epoch and ttl fields --- accounting/service.proto | 1 + accounting/withdraw.proto | 4 ++++ bootstrap/service.proto | 1 + container/service.proto | 4 ++++ object/service.proto | 14 ++++++++++++++ 5 files changed, 24 insertions(+) diff --git a/accounting/service.proto b/accounting/service.proto index f975c232..9cfdb0f6 100644 --- a/accounting/service.proto +++ b/accounting/service.proto @@ -19,6 +19,7 @@ message BalanceRequest { // OwnerID is a wallet address bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 2; } diff --git a/accounting/withdraw.proto b/accounting/withdraw.proto index 8e10ef99..eb58d080 100644 --- a/accounting/withdraw.proto +++ b/accounting/withdraw.proto @@ -38,6 +38,7 @@ message GetRequest { // OwnerID is a wallet address bytes OwnerID = 2 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 3; } @@ -58,6 +59,7 @@ message PutRequest { // Signature is a signature of the sent request bytes Signature = 5; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 6; } message PutResponse { @@ -69,6 +71,7 @@ message ListRequest { // OwnerID is a wallet address bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 2; } @@ -87,6 +90,7 @@ message DeleteRequest { // Signature is a signature of the sent request bytes Signature = 4; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 5; } diff --git a/bootstrap/service.proto b/bootstrap/service.proto index a0f82dca..cde94dcd 100644 --- a/bootstrap/service.proto +++ b/bootstrap/service.proto @@ -21,5 +21,6 @@ message Request { // Info contains information about node bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 3; } diff --git a/container/service.proto b/container/service.proto index 72c08993..1cf8227c 100644 --- a/container/service.proto +++ b/container/service.proto @@ -43,6 +43,7 @@ message PutRequest { bytes Signature = 5; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 6; } @@ -56,6 +57,7 @@ message DeleteRequest { bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 2; // Signature of the container owner @@ -72,6 +74,7 @@ message GetRequest { bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 2; } @@ -85,6 +88,7 @@ message ListRequest { bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 2; } diff --git a/object/service.proto b/object/service.proto index 5edf9355..7a971db0 100644 --- a/object/service.proto +++ b/object/service.proto @@ -53,10 +53,12 @@ service Service { message GetRequest { // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Address of object (container id + object id) refs.Address Address = 2 [(gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 3; } @@ -72,10 +74,12 @@ message GetResponse { message PutRequest { message PutHeader { // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Object with at least container id and owner id fields Object Object = 2; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 3; // Token with session public key and user's signature session.Token Token = 4; @@ -95,12 +99,14 @@ message PutResponse { } message DeleteRequest { // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Address of object (container id + object id) refs.Address Address = 2 [(gogoproto.nullable) = false]; // OwnerID is a wallet address bytes OwnerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "OwnerID"]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 4; // Token with session public key and user's signature session.Token Token = 5; @@ -112,12 +118,14 @@ message DeleteResponse {} message HeadRequest { // Epoch should be empty on user side, node sets epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Address of object (container id + object id) refs.Address Address = 2 [(gogoproto.nullable) = false, (gogoproto.customtype) = "Address"]; // FullHeaders can be set true for extended headers in the object bool FullHeaders = 3; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 4; } message HeadResponse { @@ -127,6 +135,7 @@ message HeadResponse { message SearchRequest { // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Version of search query format uint32 Version = 2; @@ -135,6 +144,7 @@ message SearchRequest { // Query in the binary serialized format bytes Query = 4; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 5; } @@ -145,12 +155,14 @@ message SearchResponse { message GetRangeRequest { // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Address of object (container id + object id) refs.Address Address = 2 [(gogoproto.nullable) = false]; // Ranges of object's payload to return repeated Range Ranges = 3 [(gogoproto.nullable) = false]; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 4; } @@ -161,6 +173,7 @@ message GetRangeResponse { message GetRangeHashRequest { // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint64 Epoch = 1; // Address of object (container id + object id) refs.Address Address = 2 [(gogoproto.nullable) = false]; @@ -169,6 +182,7 @@ message GetRangeHashRequest { // Salt is used to XOR object's payload ranges before hashing, it can be nil bytes Salt = 4; // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) uint32 TTL = 5; } From e333a13557861ac034893040af7fced87eaec5c3 Mon Sep 17 00:00:00 2001 From: Evgeniy Kulikov Date: Thu, 21 Nov 2019 10:34:38 +0300 Subject: [PATCH 3/4] docs: regenerate proto files --- accounting/service.pb.go | Bin 18893 -> 18970 bytes accounting/withdraw.pb.go | Bin 66389 -> 66702 bytes bootstrap/service.pb.go | Bin 13179 -> 13256 bytes container/service.pb.go | Bin 54848 -> 55156 bytes container/types.pb.go | Bin 11819 -> 11990 bytes object/service.pb.go | Bin 112198 -> 114748 bytes object/types.pb.go | Bin 91599 -> 93105 bytes query/types.pb.go | Bin 15260 -> 15394 bytes refs/types.pb.go | Bin 9232 -> 9267 bytes session/service.pb.go | Bin 22845 -> 24221 bytes session/types.pb.go | Bin 21236 -> 21404 bytes 11 files changed, 0 insertions(+), 0 deletions(-) diff --git a/accounting/service.pb.go b/accounting/service.pb.go index ea86a8ea5b39319dff0db38b128e077209a9233a..bc31ce1c95e387bba39ce3f43caadbbb4a6c5fec 100644 GIT binary patch delta 90 zcmX>*nQ_(>#tqRd-un6qE~y1YsmX~YsVPgtHFxt*fg9`~>CJwUSGhJ9 SsBCB1tf3hQ5&C8@<1zq6W*LzH diff --git a/bootstrap/service.pb.go b/bootstrap/service.pb.go index 14f8e9e8f27a95923a1720c598db852335ef6383..f00f814b8b9127a72859dfd937b007460c21ebcc 100644 GIT binary patch delta 88 zcmeyJb|QVlCKhjfeFc})f}+&q#FEq$D~0mRoE(LuRE46{f}F(U)D)mVNrpmDYGG+= qafxqgNuoz;VoGX}f<|#_szOR?S!zyxfkIMIVqS8F=H?A7r}Y5g9wBM~ delta 12 UcmX?+{yS~MCYH_rSx)K!0519lqyPW_ diff --git a/container/service.pb.go b/container/service.pb.go index 9cc6991a2b2aca6aea0e2c39b10708f8b4795b5d..cfd401d920b046267eef658e8ff3d2d569c6d528 100644 GIT binary patch delta 357 zcmX@GhWX1n<_!nfy!G`JTv7{)Qj-%)Qd6uH$}@9v6p~UEic$-55|dL?fC42M3PGub zrK!awzNsaN9;t~bsYMDJ#i^+ZDXC?tIr#+&Nkxfy$r+lP_pya?Q`JC0Au*~NIC&qN c(PRT5y~%RyotydOW^z)~wJ3)7X>3{x0IKGHhyVZp delta 45 zcmeyej`_eE<_!nfCiBS|Y_?@r=H9$kNQ8ScpIieMQ0V#Od*y7C4Yb)epVwTv766G+ B5gz~m diff --git a/container/types.pb.go b/container/types.pb.go index 8c4775ccd2e730da3f56eff8495cd39ae0200ff7..7bf9a03651924c5d814922abf4dc886e4ee45d13 100644 GIT binary patch delta 336 zcmY+9F-`+P3`L7g1E;VkfHVmOqJWO1AT$x6bRglK@xq|NUUodJQc-Y(y#x{s5~tt- zoCjwE2r5gq{(IlAm!DT}+r{2^4D*($nN1-iKxi>WQb6w;N@=vY@pJv2-MlzEw$KGe zT_;%B5meGZ=J1dSoUmdrCIk--qstLB2pgu{cyE>8njAz`P z*#`GgB+3CH;4tFAg$oD74QUUR5Lb{mp(=j>Cy@9d<%l@ZH@oXPDV0zuQcdNE4K#ZYYmC4sIC2=I3NRhUbPf%g5P|t7 zW&*A<5o5`t2#eT_&}RmNACN&}iRlJHq zb)gwC>4#G#FFQ=krJ0|#w+@|riNe=|AVRG{wLmrBLf^ooucTpIQXC$@bbpu!6d|8& zuQ$#(bmz`Bpc89Ch9FqfcGyBD;TlHjFmM9_`VlfsC*>08I8hHIs+NA0}0Tf zibddb3p-uY1EOFm&6)=|kY)}4tu`MVi1Tjo`nxv2e4k{$qs?Hq_m7bpjM>j;53W&^ zrC5l}7c}@J&V<>Sk%?l2mWlx1HYfv<=rA=8?WEc{QDz4vZ|C}^Qi7^@!WQO^K5V|+ z(*V|&8}`HcMlvz~L1D}l!az?|Y@o|}La`wE;`k4R0U3tWo?oQ%zkyMzk7UmpSwy`A zc|Ex(C9cCv$?LzrBd~kzo`rd5>?iszPBP%qoGs_Fy(_spXPr2`NLq0I2rYg+-6SVM zlS@Whk|c8`_%&imfA?&fy|VU<{c&Mt*a(qS>c1BE5t_Vf!L-Y1sn|Ja$_t(RvGhc7 z=!x(^ecCa)fK?{j8Tt%2S!-Sit{07vELN7heAfD#=^y)B$r%c0pfoeD#LNUFIC-O$=;ZkpMw9bZjVIS@>r8&=F2@KF zz02w|*+HIV@(0!8$+HjeY+k@NTU3#NaYzO#JIJwut)0A4Kz4G2tR~24W|)Y8r;Am_)nIbZcA3kfFYt11DVC}^oYdAF*tvVVDAYLTZ4*eW=IDmeL;b|8}N&YNv@ zS8++>@d{F?h;lflq!gtV7lUjJly)o4$?-@{Oi3*&hFhkPl%Jmi_4!>^?#Y)eje)iq zOzsNZKAGQ5`59{Xn(ULTB zfnsoCP6>K2D8Rx2BmoW!iDXr{TSX`TO-3a4xW9ap6MnFR+`IWf$}ZOC(^=b3XE7Fr F0suPY{&fHV diff --git a/object/types.pb.go b/object/types.pb.go index 99b6c90fadc29d7b37401dfd813966a1becaaf8b..217ef099bce185ff81f21d608ca4c4bf8340712f 100644 GIT binary patch delta 2653 zcmbtWO=u)V6ecFKW@f^YxQZbmvD`(n8%-vO*;&{q=HJB3CcBwLW{FF-rn`E&Ha*=# zSM?<04?#S5^iT-GdKM3Y34QP)f%Pil!GqvMy?7DSn+OZ~s;YZ_@}n#=44vtE?|ZM_ z``-8R?bnIJ?-K{FweRPsyR*Gfs}S@u8cQWJ8FUl-#O25<-XjJ_hEFgjCNcw`x~2Fn z_p!??&o5(6JvWt9D3N0`;vYk4DH&)J)RG?IPp;h*BlR?9*Dn;v2A5Jv$c=9QK(66r(~-KZO00A>7-3s}?vj+9WD zGA5rk!6pP}P##4fP0{9%3O4-c+^=n;P^C@Rp=B!B3xN=|T8oLWvx{pCRk1@&@owiu z@zr*pIO;sN2(GKdTg)$1Ji|WS7doT-P~dXv0EI2WX_;t0M5H4?_KF`mpMO|A|0949O zik}M?#AmnCf~T+agIkWcC2pT|3-70oI)=bth1B9x=&L`(qT;8L@`Q0I2IBLn0U^3C z4S@aY*a^s~9^#y>byq?h>?%Su8iAkeyKZewaNF z_lMJAdH9p|2^oj@3=}7h6p0k%6Bs=3;o7l5%e}kA#^~@YxZl(x5nUhZj_b1%Pm7~U zlS;Ol*5L-l(de~n0JS`iTKuUAs!1(M{1?1O98f zF7YD}xVqy&8?kBngfVDdbQnFwTbWzy;4>H7=a*(Cu4a*qS-pvd=WDskW|e#J5=7Y_ zm{7@HH4}PIq>>Gn7D|p}M`RM35@({Rfz*S=!b0|XVhenhlpwG5NI|jdNVyR zVyohruAT7DS>BGC;zUhs-E$#b{ITOISmkSsld`S^G6^$$S|qS})a&}(H(QA}RyOCr zGpb&b6IKc*EAJxM#l)4{%+_s6C1d-oJNhqi*#D&XWo7tTz>4NAs<6%&WG5O+aXyE{ z!Bmg0pbIa{CdHSa66O&KKME%)41$Di@Rh3kkHUaXxQbSd_hyAboiMV* zyUIm9g{g=k{F9nHkWEOOD3>adke^v8^Qu@A(aR;(G_e_eQB>uch|VGZL=Y6nZM1GX8vm9$T=4mip55__~|HNgvrWz{&|X8u@gQ>BuO6qtAPz{L~; z?T%CUn&SmUM^KH>o;Z78${E1x&ev|d*0)Zz%pytVDZ$Uga(1ZUv+yaD^iPcHx4p&$LT9HJ?hJJKr*4W!GKI(+69^v%;{K8S6jj*- z!fDnE_XoT2kHJ^8Jt^|q1mIh)TkE%NxF6Q~g80#}oo*XPT#>XlvV<0v<*GoMdl~kT z{u%Iv&*Nv|do&axM<6ybx54+wFem4vhjJ&jM)JrvkH0XP>8z=Mnnwm0l}VLDBL zGv##e8~&~`Sym@RQsJ&yuFMxXg)DNMlZ}n-akUqumlH6VYK7zJGx%=$A>B^K*Zc)^ zRsB=5!Sx&upL4#p-E4+KcJBjM{!-mzgJkAdecA&-%^iho<}iF6It2MmroP48-pOz7 Ied%#5{$hR0Y?H#N-l%{33;*)b!Mf$vc^pCMz?`ZJx{A GY5@Sz_z{=@ diff --git a/refs/types.pb.go b/refs/types.pb.go index 87f3fcede248ce3edcab87de6efcbef50939296b..2ccde2f2b821e7d31a8544e8213f806c97288820 100644 GIT binary patch delta 48 zcmbQ>vDssT60@?7LRn%?W{N^+sHaPri9%6oK~ZXPYFB=;m9MG$*!`{NSygi4YE>BK>htNegU~=xhwzx delta 19 bcmbQcmvQeV#tnK3o9`)^uxvi0dD{d4RwW2x diff --git a/session/types.pb.go b/session/types.pb.go index d39961e816331ab73f04c85f5cc7f1fe994020e0..f597612920bb1e6cbb44068aed1b2e3650ff2995 100644 GIT binary patch delta 254 zcmeyelyS~-#tn~|1OiHvax#;>Q!5oRixmvoo%u#R}G`*=Ovbu7NzPb1W&H#Y2$|od%7rSgob*$Xl{1kjd242@8cgi From 27a129c79523571fb2f6302aa58298b244804e02 Mon Sep 17 00:00:00 2001 From: Evgeniy Kulikov Date: Thu, 21 Nov 2019 10:35:17 +0300 Subject: [PATCH 4/4] docs: regenerate proto documentation --- docs/accounting.md | 14 ++++---- docs/bootstrap.md | 2 +- docs/container.md | 8 ++--- docs/object.md | 84 +++++++++++++++++++++++----------------------- docs/query.md | 6 ++-- docs/refs.md | 2 +- docs/session.md | 35 ++++++++++--------- 7 files changed, 78 insertions(+), 73 deletions(-) diff --git a/docs/accounting.md b/docs/accounting.md index f08bd52d..b4317aee 100644 --- a/docs/accounting.md +++ b/docs/accounting.md @@ -87,7 +87,7 @@ Balance returns current balance status of the NeoFS user | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -362,7 +362,7 @@ Delete allows user to remove unused cheque | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | | MessageID | [bytes](#bytes) | | MessageID is a nonce for uniq request (UUIDv4) | | Signature | [bytes](#bytes) | | Signature is a signature of the sent request | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -382,7 +382,7 @@ DeleteResponse is empty | ----- | ---- | ----- | ----------- | | ID | [bytes](#bytes) | | ID is cheque identifier | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -393,7 +393,7 @@ DeleteResponse is empty | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Withdraw | [Item](#accounting.Item) | | Item is cheque with meta information | +| Withdraw | [Item](#accounting.Item) | | Withdraw is cheque with meta information | @@ -420,7 +420,7 @@ DeleteResponse is empty | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -431,7 +431,7 @@ DeleteResponse is empty | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Items | [Item](#accounting.Item) | repeated | Item is a set of cheques with meta information | +| Items | [Item](#accounting.Item) | repeated | Items is a set of cheques with meta information | @@ -447,7 +447,7 @@ DeleteResponse is empty | Height | [uint64](#uint64) | | Height is the neo blockchain height until the cheque is valid | | MessageID | [bytes](#bytes) | | MessageID is a nonce for uniq request (UUIDv4) | | Signature | [bytes](#bytes) | | Signature is a signature of the sent request | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | diff --git a/docs/bootstrap.md b/docs/bootstrap.md index dfada2c6..19967bfa 100644 --- a/docs/bootstrap.md +++ b/docs/bootstrap.md @@ -62,7 +62,7 @@ Process is method that allows to register node in the network and receive actual | ----- | ---- | ----- | ----------- | | type | [int32](#int32) | | Type is NodeType, can be InnerRingNode (type=1) or StorageNode (type=2) | | info | [NodeInfo](#bootstrap.NodeInfo) | | Info contains information about node | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | diff --git a/docs/container.md b/docs/container.md index 5ff0d891..4f98a47d 100644 --- a/docs/container.md +++ b/docs/container.md @@ -92,7 +92,7 @@ List returns all user's containers | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | CID | [bytes](#bytes) | | CID (container id) is a SHA256 hash of the container structure | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Signature | [bytes](#bytes) | | Signature of the container owner | @@ -113,7 +113,7 @@ via consensus in inner ring nodes | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | CID | [bytes](#bytes) | | CID (container id) is a SHA256 hash of the container structure | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -136,7 +136,7 @@ via consensus in inner ring nodes | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -163,7 +163,7 @@ via consensus in inner ring nodes | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | | rules | [netmap.PlacementRule](#netmap.PlacementRule) | | Rules define storage policy for the object inside the container. | | Signature | [bytes](#bytes) | | Signature of the user (owner id) | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | diff --git a/docs/object.md b/docs/object.md index 5ba1845b..03e41c84 100644 --- a/docs/object.md +++ b/docs/object.md @@ -147,10 +147,10 @@ calculated for XORed data. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Token | [session.Token](#session.Token) | | Token with session public key and user's signature | @@ -170,11 +170,11 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | Ranges | [Range](#object.Range) | repeated | Ranges of object's payload to calculate homomorphic hash | | Salt | [bytes](#bytes) | | Salt is used to XOR object's payload ranges before hashing, it can be nil | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -185,7 +185,7 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Hashes | [bytes](#bytes) | repeated | Homomorphic hashes of all ranges | +| Hashes | [bytes](#bytes) | repeated | Hashes is a homomorphic hashes of all ranges | @@ -196,10 +196,10 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | Ranges | [Range](#object.Range) | repeated | Ranges of object's payload to return | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -221,9 +221,9 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -246,10 +246,10 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch should be empty on user side, node sets epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Address | [refs.Address](#refs.Address) | | Address of object (container id + object id) | | FullHeaders | [bool](#bool) | | FullHeaders can be set true for extended headers in the object | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -283,9 +283,9 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Object | [Object](#object.Object) | | Object with at least container id and owner id fields | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Token | [session.Token](#session.Token) | | Token with session public key and user's signature | @@ -308,11 +308,11 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value | +| Epoch | [uint64](#uint64) | | Epoch is set by user to 0, node set epoch to the actual value Deprecated: will be replaced with RequestMetaHeader (see develop branch) | | Version | [uint32](#uint32) | | Version of search query format | | ContainerID | [bytes](#bytes) | | ContainerID for searching the object | | Query | [bytes](#bytes) | | Query in the binary serialized format | -| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node | +| TTL | [uint32](#uint32) | | TTL must be larger than zero, it decreased in every neofs-node Deprecated: will be replaced with RequestMetaHeader (see develop branch) | @@ -348,8 +348,8 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| UnixTime | [int64](#int64) | | Date of creation in unixtime format | -| Epoch | [uint64](#uint64) | | Date of creation in NeoFS epochs | +| UnixTime | [int64](#int64) | | UnixTime is a date of creation in unixtime format | +| Epoch | [uint64](#uint64) | | Epoch is a date of creation in NeoFS epochs | @@ -361,12 +361,12 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Link | [Link](#object.Link) | | Link to other objects | -| Redirect | [refs.Address](#refs.Address) | | RedirectNot used yet | -| UserHeader | [UserHeader](#object.UserHeader) | | UserHeader defined by user | +| Redirect | [refs.Address](#refs.Address) | | Redirect not used yet | +| UserHeader | [UserHeader](#object.UserHeader) | | UserHeader is a set of KV headers defined by user | | Transform | [Transform](#object.Transform) | | Transform defines transform operation (e.g. payload split) | | Tombstone | [Tombstone](#object.Tombstone) | | Tombstone header that set up in deleted objects | | Verify | [session.VerificationHeader](#session.VerificationHeader) | | Verify header that contains session public key and user's signature | -| HomoHash | [bytes](#bytes) | | Homomorphic hash of original object payload | +| HomoHash | [bytes](#bytes) | | HomoHash is a homomorphic hash of original object payload | | PayloadChecksum | [bytes](#bytes) | | PayloadChecksum of actual object's payload | | Integrity | [IntegrityHeader](#object.IntegrityHeader) | | Integrity header with checksum of all above headers in the object | | StorageGroup | [StorageGroup](#object.StorageGroup) | | StorageGroup contains meta information for the data audit | @@ -380,8 +380,8 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| HeadersChecksum | [bytes](#bytes) | | Checksum of all above headers in the object | -| ChecksumSignature | [bytes](#bytes) | | User's signature of checksum to verify if it is correct | +| HeadersChecksum | [bytes](#bytes) | | HeadersChecksum is a checksum of all above headers in the object | +| ChecksumSignature | [bytes](#bytes) | | ChecksumSignature is an user's signature of checksum to verify if it is correct | @@ -392,8 +392,8 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| type | [Link.Type](#object.Link.Type) | | Link type | -| ID | [bytes](#bytes) | | Object id | +| type | [Link.Type](#object.Link.Type) | | Type of link | +| ID | [bytes](#bytes) | | ID is an object identifier, is a valid UUIDv4 | @@ -404,9 +404,9 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| SystemHeader | [SystemHeader](#object.SystemHeader) | | System header | -| Headers | [Header](#object.Header) | repeated | Extended headers | -| Payload | [bytes](#bytes) | | Object's payload | +| SystemHeader | [SystemHeader](#object.SystemHeader) | | SystemHeader describes system header | +| Headers | [Header](#object.Header) | repeated | Headers describes a set of an extended headers | +| Payload | [bytes](#bytes) | | Payload is an object's payload | @@ -429,9 +429,9 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| ValidationDataSize | [uint64](#uint64) | | Size of the all object's payloads included into storage group | -| ValidationHash | [bytes](#bytes) | | Homomorphic hash of all object's payloads included into storage group | -| lifetime | [StorageGroup.Lifetime](#object.StorageGroup.Lifetime) | | Time until storage group is valid | +| 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 | +| lifetime | [StorageGroup.Lifetime](#object.StorageGroup.Lifetime) | | Lifetime is time until storage group is valid | @@ -442,8 +442,8 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| unit | [StorageGroup.Lifetime.Unit](#object.StorageGroup.Lifetime.Unit) | | Lifetime type | -| Value | [int64](#int64) | | Lifetime value | +| unit | [StorageGroup.Lifetime.Unit](#object.StorageGroup.Lifetime.Unit) | | Unit is lifetime type | +| Value | [int64](#int64) | | Value for lifetime | @@ -455,11 +455,11 @@ in distributed system. | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Version | [uint64](#uint64) | | Version of the object structure | -| PayloadLength | [uint64](#uint64) | | Object payload length | -| ID | [bytes](#bytes) | | ObjectID is a UUID | +| PayloadLength | [uint64](#uint64) | | PayloadLength is an object payload length | +| ID | [bytes](#bytes) | | ID is an object identifier, is a valid UUIDv4 | | OwnerID | [bytes](#bytes) | | OwnerID is a wallet address | -| CID | [bytes](#bytes) | | ContainerID is a SHA256 hash of the container structure | -| CreatedAt | [CreationPoint](#object.CreationPoint) | | Timestamp of object creation | +| CID | [bytes](#bytes) | | CID is a SHA256 hash of the container structure (container identifier) | +| CreatedAt | [CreationPoint](#object.CreationPoint) | | CreatedAt is a timestamp of object creation | @@ -521,9 +521,9 @@ in distributed system. | Name | Number | Description | | ---- | ------ | ----------- | -| Unlimited | 0 | Storage group always valid | -| NeoFSEpoch | 1 | Storage group is valid until lifetime NeoFS epoch | -| UnixTime | 2 | Storage group is valid until lifetime unix timestamp | +| Unlimited | 0 | Unlimited set if storage group always valid | +| NeoFSEpoch | 1 | NeoFSEpoch set if storage group is valid until lifetime NeoFS epoch | +| UnixTime | 2 | UnixTime set if storage group is valid until lifetime unix timestamp | @@ -535,9 +535,9 @@ in distributed system. | Name | Number | Description | | ---- | ------ | ----------- | | Unknown | 0 | | -| Split | 1 | Object created after payload split | -| Sign | 2 | Object created after re-signing (doesn't used) | -| Mould | 3 | Object created after filling missing headers in the object | +| Split | 1 | Split sets when object created after payload split | +| Sign | 2 | Sign sets when object created after re-signing (doesn't used) | +| Mould | 3 | Mould sets when object created after filling missing headers in the object | diff --git a/docs/query.md b/docs/query.md index 9deb2c19..c014c6c7 100644 --- a/docs/query.md +++ b/docs/query.md @@ -52,12 +52,12 @@ ### Filter.Type -Type can be Exact or Regex + | Name | Number | Description | | ---- | ------ | ----------- | -| Exact | 0 | | -| Regex | 1 | | +| Exact | 0 | Exact sets when value of filter should be equal to the header value | +| Regex | 1 | Regex sets when value of filter should match the header value by the regular expression | diff --git a/docs/refs.md b/docs/refs.md index c3051ab2..b8084825 100644 --- a/docs/refs.md +++ b/docs/refs.md @@ -30,7 +30,7 @@ Address of object (container id + object id) | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| ObjectID | [bytes](#bytes) | | ObjectID is an object identifier | +| ObjectID | [bytes](#bytes) | | ObjectID is an object identifier, valid UUIDv4 represented in bytes | | CID | [bytes](#bytes) | | CID is container identifier | diff --git a/docs/session.md b/docs/session.md index 8ea703e9..cf4a1fd0 100644 --- a/docs/session.md +++ b/docs/session.md @@ -34,11 +34,7 @@ ### Service "session.Session" -Open a trusted session to manipulate an object. In order to put or -delete object client have to obtain session token with trusted node. -Trusted node will modify client's object (add missing headers, checksums, -homomorphic hash) and sign id with session key. Session is established -during 4-step handshake in one gRPC stream + ``` rpc Create(stream CreateRequest) returns (stream CreateResponse); @@ -47,7 +43,16 @@ rpc Create(stream CreateRequest) returns (stream CreateResponse); #### Method Create +Create is a method that used to open a trusted session to manipulate +an object. In order to put or delete object client have to obtain session +token with trusted node. Trusted node will modify client's object +(add missing headers, checksums, homomorphic hash) and sign id with +session key. Session is established during 4-step handshake in one gRPC stream +- First client stream message SHOULD BE type of `CreateRequest_Init`. +- First server stream message SHOULD BE type of `CreateResponse_Unsigned`. +- Second client stream message SHOULD BE type of `CreateRequest_Signed`. +- Second server stream message SHOULD BE type of `CreateResponse_Result`. | Name | Input | Output | | ---- | ----- | ------ | @@ -63,7 +68,7 @@ rpc Create(stream CreateRequest) returns (stream CreateResponse); | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| Init | [Token](#session.Token) | | Message to init session opening. Carry: owner of manipulation object; ID of manipulation object; token lifetime bounds. | +| Init | [Token](#session.Token) | | Init is a message to initialize session opening. Carry: owner of manipulation object; ID of manipulation object; token lifetime bounds. | | Signed | [Token](#session.Token) | | Signed Init message response (Unsigned) from server with user private key | @@ -76,7 +81,7 @@ rpc Create(stream CreateRequest) returns (stream CreateResponse); | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Unsigned | [Token](#session.Token) | | Unsigned token with token ID and session public key generated on server side | -| Result | [Token](#session.Token) | | Resulting token which can be used for object placing through an trusted intermediary | +| Result | [Token](#session.Token) | | Result is a resulting token which can be used for object placing through an trusted intermediary | @@ -102,12 +107,12 @@ User token granting rights for object manipulation | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | | Header | [VerificationHeader](#session.VerificationHeader) | | Header carries verification data of session key | -| OwnerID | [bytes](#bytes) | | Owner of manipulation object | -| FirstEpoch | [uint64](#uint64) | | Initial epoch of token lifetime | -| LastEpoch | [uint64](#uint64) | | Last epoch of token lifetime | -| ObjectID | [bytes](#bytes) | repeated | ID of manipulation object | -| Signature | [bytes](#bytes) | | Token signature. Signed by owner of manipulation object | -| ID | [bytes](#bytes) | | Token ID (UUID) | +| OwnerID | [bytes](#bytes) | | OwnerID is an owner of manipulation object | +| FirstEpoch | [uint64](#uint64) | | FirstEpoch is an initial epoch of token lifetime | +| LastEpoch | [uint64](#uint64) | | LastEpoch is a last epoch of token lifetime | +| ObjectID | [bytes](#bytes) | repeated | ObjectID is an object identifier of manipulation object | +| Signature | [bytes](#bytes) | | Signature is a token signature, signed by owner of manipulation object | +| ID | [bytes](#bytes) | | ID is a token identifier. valid UUIDv4 represented in bytes | @@ -118,8 +123,8 @@ User token granting rights for object manipulation | Field | Type | Label | Description | | ----- | ---- | ----- | ----------- | -| PublicKey | [bytes](#bytes) | | Session public key | -| KeySignature | [bytes](#bytes) | | Session public key signature. Signed by trusted side | +| PublicKey | [bytes](#bytes) | | PublicKey is a session public key | +| KeySignature | [bytes](#bytes) | | KeySignature is a session public key signature. Signed by trusted side |