From e333a13557861ac034893040af7fced87eaec5c3 Mon Sep 17 00:00:00 2001 From: Evgeniy Kulikov Date: Thu, 21 Nov 2019 10:34:38 +0300 Subject: [PATCH] docs: regenerate proto files --- accounting/service.pb.go | 1 + accounting/withdraw.pb.go | 8 ++- bootstrap/service.pb.go | 1 + container/service.pb.go | 4 ++ container/types.pb.go | 10 +++- object/service.pb.go | 119 +++++++++++++++++++++++++++----------- object/types.pb.go | 111 +++++++++++++++++++++++------------ query/types.pb.go | 3 +- refs/types.pb.go | 2 +- session/service.pb.go | 20 +++++++ session/types.pb.go | 16 ++--- 11 files changed, 208 insertions(+), 87 deletions(-) diff --git a/accounting/service.pb.go b/accounting/service.pb.go index ea86a8e..bc31ce1 100644 --- a/accounting/service.pb.go +++ b/accounting/service.pb.go @@ -32,6 +32,7 @@ type BalanceRequest struct { // OwnerID is a wallet address OwnerID OwnerID `protobuf:"bytes,1,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,2,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/accounting/withdraw.pb.go b/accounting/withdraw.pb.go index b50bc1c..f0e78aa 100644 --- a/accounting/withdraw.pb.go +++ b/accounting/withdraw.pb.go @@ -100,6 +100,7 @@ type GetRequest struct { // OwnerID is a wallet address OwnerID OwnerID `protobuf:"bytes,2,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -143,7 +144,7 @@ func (m *GetRequest) GetTTL() uint32 { } type GetResponse struct { - // Item is cheque with meta information + // Withdraw is cheque with meta information Withdraw *Item `protobuf:"bytes,1,opt,name=Withdraw,proto3" json:"Withdraw,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -198,6 +199,7 @@ type PutRequest struct { // Signature is a signature of the sent request Signature []byte `protobuf:"bytes,5,opt,name=Signature,proto3" json:"Signature,omitempty"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,6,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -302,6 +304,7 @@ type ListRequest struct { // OwnerID is a wallet address OwnerID OwnerID `protobuf:"bytes,1,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,2,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -345,7 +348,7 @@ func (m *ListRequest) GetTTL() uint32 { } type ListResponse struct { - // Item is a set of cheques with meta information + // Items is a set of cheques with meta information Items []*Item `protobuf:"bytes,1,rep,name=Items,proto3" json:"Items,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -398,6 +401,7 @@ type DeleteRequest struct { // Signature is a signature of the sent request Signature []byte `protobuf:"bytes,4,opt,name=Signature,proto3" json:"Signature,omitempty"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,5,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/bootstrap/service.pb.go b/bootstrap/service.pb.go index 14f8e9e..f00f814 100644 --- a/bootstrap/service.pb.go +++ b/bootstrap/service.pb.go @@ -33,6 +33,7 @@ type Request struct { // Info contains information about node Info NodeInfo `protobuf:"bytes,2,opt,name=info,proto3" json:"info"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/container/service.pb.go b/container/service.pb.go index 9cc6991..cfd401d 100644 --- a/container/service.pb.go +++ b/container/service.pb.go @@ -40,6 +40,7 @@ type PutRequest struct { // Signature of the user (owner id) Signature []byte `protobuf:"bytes,5,opt,name=Signature,proto3" json:"Signature,omitempty"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,6,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -144,6 +145,7 @@ type DeleteRequest struct { // CID (container id) is a SHA256 hash of the container structure CID CID `protobuf:"bytes,1,opt,name=CID,proto3,customtype=CID" json:"CID"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,2,opt,name=TTL,proto3" json:"TTL,omitempty"` // Signature of the container owner Signature []byte `protobuf:"bytes,3,opt,name=Signature,proto3" json:"Signature,omitempty"` @@ -236,6 +238,7 @@ type GetRequest struct { // CID (container id) is a SHA256 hash of the container structure CID CID `protobuf:"bytes,1,opt,name=CID,proto3,customtype=CID" json:"CID"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,2,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -326,6 +329,7 @@ type ListRequest struct { // OwnerID is a wallet address OwnerID OwnerID `protobuf:"bytes,1,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,2,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/container/types.pb.go b/container/types.pb.go index 8c4775c..7bf9a03 100644 --- a/container/types.pb.go +++ b/container/types.pb.go @@ -26,9 +26,13 @@ const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package // The Container service definition. type Container struct { - OwnerID OwnerID `protobuf:"bytes,1,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` - Salt UUID `protobuf:"bytes,2,opt,name=Salt,proto3,customtype=UUID" json:"Salt"` - Capacity uint64 `protobuf:"varint,3,opt,name=Capacity,proto3" json:"Capacity,omitempty"` + // OwnerID is a wallet address. + OwnerID OwnerID `protobuf:"bytes,1,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` + // Salt is a nonce for unique container id calculation. + Salt UUID `protobuf:"bytes,2,opt,name=Salt,proto3,customtype=UUID" json:"Salt"` + // Capacity defines amount of data that can be stored in the container (doesn't used for now). + Capacity uint64 `protobuf:"varint,3,opt,name=Capacity,proto3" json:"Capacity,omitempty"` + // Rules define storage policy for the object inside the container. Rules netmap.PlacementRule `protobuf:"bytes,4,opt,name=Rules,proto3" json:"Rules"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/object/service.pb.go b/object/service.pb.go index 8301ebb..b19ed93 100644 --- a/object/service.pb.go +++ b/object/service.pb.go @@ -30,12 +30,17 @@ var _ = math.Inf const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package type GetRequest struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` - TTL uint32 `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Address of object (container id + object id) + Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + TTL uint32 `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *GetRequest) Reset() { *m = GetRequest{} } @@ -257,9 +262,15 @@ func (*PutRequest) XXX_OneofWrappers() []interface{} { } type PutRequest_PutHeader struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Object *Object `protobuf:"bytes,2,opt,name=Object,proto3" json:"Object,omitempty"` - TTL uint32 `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"` + // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Object with at least container id and owner id fields + Object *Object `protobuf:"bytes,2,opt,name=Object,proto3" json:"Object,omitempty"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + TTL uint32 `protobuf:"varint,3,opt,name=TTL,proto3" json:"TTL,omitempty"` + // Token with session public key and user's signature Token *session.Token `protobuf:"bytes,4,opt,name=Token,proto3" json:"Token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -324,6 +335,7 @@ func (m *PutRequest_PutHeader) GetToken() *session.Token { } type PutResponse struct { + // Address of object (container id + object id) Address refs.Address `protobuf:"bytes,1,opt,name=Address,proto3" json:"Address"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -367,10 +379,17 @@ func (m *PutResponse) GetAddress() refs.Address { } type DeleteRequest struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` - OwnerID OwnerID `protobuf:"bytes,3,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` - TTL uint32 `protobuf:"varint,4,opt,name=TTL,proto3" json:"TTL,omitempty"` + // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Address of object (container id + object id) + Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` + // OwnerID is a wallet address + OwnerID OwnerID `protobuf:"bytes,3,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + TTL uint32 `protobuf:"varint,4,opt,name=TTL,proto3" json:"TTL,omitempty"` + // Token with session public key and user's signature Token *session.Token `protobuf:"bytes,5,opt,name=Token,proto3" json:"Token,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -472,9 +491,15 @@ func (m *DeleteResponse) XXX_DiscardUnknown() { var xxx_messageInfo_DeleteResponse proto.InternalMessageInfo type HeadRequest struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Address Address `protobuf:"bytes,2,opt,name=Address,proto3,customtype=Address" json:"Address"` - FullHeaders bool `protobuf:"varint,3,opt,name=FullHeaders,proto3" json:"FullHeaders,omitempty"` + // Epoch should be empty on user side, node sets epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Address of object (container id + object id) + Address Address `protobuf:"bytes,2,opt,name=Address,proto3,customtype=Address" json:"Address"` + // FullHeaders can be set true for extended headers in the object + FullHeaders bool `protobuf:"varint,3,opt,name=FullHeaders,proto3" json:"FullHeaders,omitempty"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,4,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -532,6 +557,7 @@ func (m *HeadRequest) GetTTL() uint32 { } type HeadResponse struct { + // Object without payload Object *Object `protobuf:"bytes,1,opt,name=Object,proto3" json:"Object,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -575,10 +601,17 @@ func (m *HeadResponse) GetObject() *Object { } type SearchRequest struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Version uint32 `protobuf:"varint,2,opt,name=Version,proto3" json:"Version,omitempty"` - ContainerID CID `protobuf:"bytes,3,opt,name=ContainerID,proto3,customtype=CID" json:"ContainerID"` - Query []byte `protobuf:"bytes,4,opt,name=Query,proto3" json:"Query,omitempty"` + // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Version of search query format + Version uint32 `protobuf:"varint,2,opt,name=Version,proto3" json:"Version,omitempty"` + // ContainerID for searching the object + ContainerID CID `protobuf:"bytes,3,opt,name=ContainerID,proto3,customtype=CID" json:"ContainerID"` + // Query in the binary serialized format + Query []byte `protobuf:"bytes,4,opt,name=Query,proto3" json:"Query,omitempty"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) TTL uint32 `protobuf:"varint,5,opt,name=TTL,proto3" json:"TTL,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -643,6 +676,7 @@ func (m *SearchRequest) GetTTL() uint32 { } type SearchResponse struct { + // Addresses of found objects Addresses []refs.Address `protobuf:"bytes,1,rep,name=Addresses,proto3" json:"Addresses"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -686,13 +720,19 @@ func (m *SearchResponse) GetAddresses() []refs.Address { } type GetRangeRequest struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` - Ranges []Range `protobuf:"bytes,3,rep,name=Ranges,proto3" json:"Ranges"` - TTL uint32 `protobuf:"varint,4,opt,name=TTL,proto3" json:"TTL,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Address of object (container id + object id) + Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` + // Ranges of object's payload to return + Ranges []Range `protobuf:"bytes,3,rep,name=Ranges,proto3" json:"Ranges"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + TTL uint32 `protobuf:"varint,4,opt,name=TTL,proto3" json:"TTL,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *GetRangeRequest) Reset() { *m = GetRangeRequest{} } @@ -753,6 +793,7 @@ func (m *GetRangeRequest) GetTTL() uint32 { } type GetRangeResponse struct { + // Fragments of object's payload Fragments [][]byte `protobuf:"bytes,1,rep,name=Fragments,proto3" json:"Fragments,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -796,14 +837,21 @@ func (m *GetRangeResponse) GetFragments() [][]byte { } type GetRangeHashRequest struct { - Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` - Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` - Ranges []Range `protobuf:"bytes,3,rep,name=Ranges,proto3" json:"Ranges"` - Salt []byte `protobuf:"bytes,4,opt,name=Salt,proto3" json:"Salt,omitempty"` - TTL uint32 `protobuf:"varint,5,opt,name=TTL,proto3" json:"TTL,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Epoch is set by user to 0, node set epoch to the actual value + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` + // Address of object (container id + object id) + Address refs.Address `protobuf:"bytes,2,opt,name=Address,proto3" json:"Address"` + // Ranges of object's payload to calculate homomorphic hash + Ranges []Range `protobuf:"bytes,3,rep,name=Ranges,proto3" json:"Ranges"` + // Salt is used to XOR object's payload ranges before hashing, it can be nil + Salt []byte `protobuf:"bytes,4,opt,name=Salt,proto3" json:"Salt,omitempty"` + // TTL must be larger than zero, it decreased in every neofs-node + // Deprecated: will be replaced with RequestMetaHeader (see develop branch) + TTL uint32 `protobuf:"varint,5,opt,name=TTL,proto3" json:"TTL,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *GetRangeHashRequest) Reset() { *m = GetRangeHashRequest{} } @@ -871,6 +919,7 @@ func (m *GetRangeHashRequest) GetTTL() uint32 { } type GetRangeHashResponse struct { + // Hashes is a homomorphic hashes of all ranges Hashes []Hash `protobuf:"bytes,1,rep,name=Hashes,proto3,customtype=Hash" json:"Hashes"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` diff --git a/object/types.pb.go b/object/types.pb.go index 99b6c90..217ef09 100644 --- a/object/types.pb.go +++ b/object/types.pb.go @@ -28,11 +28,16 @@ const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package type Link_Type int32 const ( - Link_Unknown Link_Type = 0 - Link_Parent Link_Type = 1 - Link_Previous Link_Type = 2 - Link_Next Link_Type = 3 - Link_Child Link_Type = 4 + Link_Unknown Link_Type = 0 + // Parent object created during object transformation + Link_Parent Link_Type = 1 + // Previous object in the linked list created during object transformation + Link_Previous Link_Type = 2 + // Next object in the linked list created during object transformation + Link_Next Link_Type = 3 + // Child object created during object transformation + Link_Child Link_Type = 4 + // Object that included into this storage group Link_StorageGroup Link_Type = 5 ) @@ -66,9 +71,12 @@ type Transform_Type int32 const ( Transform_Unknown Transform_Type = 0 - Transform_Split Transform_Type = 1 - Transform_Sign Transform_Type = 2 - Transform_Mould Transform_Type = 3 + // Split sets when object created after payload split + Transform_Split Transform_Type = 1 + // Sign sets when object created after re-signing (doesn't used) + Transform_Sign Transform_Type = 2 + // Mould sets when object created after filling missing headers in the object + Transform_Mould Transform_Type = 3 ) var Transform_Type_name = map[int32]string{ @@ -96,9 +104,12 @@ func (Transform_Type) EnumDescriptor() ([]byte, []int) { type StorageGroup_Lifetime_Unit int32 const ( - StorageGroup_Lifetime_Unlimited StorageGroup_Lifetime_Unit = 0 + // Unlimited set if storage group always valid + StorageGroup_Lifetime_Unlimited StorageGroup_Lifetime_Unit = 0 + // NeoFSEpoch set if storage group is valid until lifetime NeoFS epoch StorageGroup_Lifetime_NeoFSEpoch StorageGroup_Lifetime_Unit = 1 - StorageGroup_Lifetime_UnixTime StorageGroup_Lifetime_Unit = 2 + // UnixTime set if storage group is valid until lifetime unix timestamp + StorageGroup_Lifetime_UnixTime StorageGroup_Lifetime_Unit = 2 ) var StorageGroup_Lifetime_Unit_name = map[int32]string{ @@ -122,7 +133,9 @@ func (StorageGroup_Lifetime_Unit) EnumDescriptor() ([]byte, []int) { } type Range struct { - Offset uint64 `protobuf:"varint,1,opt,name=Offset,proto3" json:"Offset,omitempty"` + // Offset of the data range + Offset uint64 `protobuf:"varint,1,opt,name=Offset,proto3" json:"Offset,omitempty"` + // Length of the data range Length uint64 `protobuf:"varint,2,opt,name=Length,proto3" json:"Length,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -173,7 +186,9 @@ func (m *Range) GetLength() uint64 { } type UserHeader struct { - Key string `protobuf:"bytes,1,opt,name=Key,proto3" json:"Key,omitempty"` + // Key of the user's header + Key string `protobuf:"bytes,1,opt,name=Key,proto3" json:"Key,omitempty"` + // Value of the user's header Value string `protobuf:"bytes,2,opt,name=Value,proto3" json:"Value,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -405,6 +420,7 @@ func (*Header) XXX_OneofWrappers() []interface{} { } type Tombstone struct { + // Epoch when tombstone was created Epoch uint64 `protobuf:"varint,1,opt,name=Epoch,proto3" json:"Epoch,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -448,11 +464,17 @@ func (m *Tombstone) GetEpoch() uint64 { } type SystemHeader struct { - Version uint64 `protobuf:"varint,1,opt,name=Version,proto3" json:"Version,omitempty"` - PayloadLength uint64 `protobuf:"varint,2,opt,name=PayloadLength,proto3" json:"PayloadLength,omitempty"` - ID ID `protobuf:"bytes,3,opt,name=ID,proto3,customtype=ID" json:"ID"` - OwnerID OwnerID `protobuf:"bytes,4,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` - CID CID `protobuf:"bytes,5,opt,name=CID,proto3,customtype=CID" json:"CID"` + // Version of the object structure + Version uint64 `protobuf:"varint,1,opt,name=Version,proto3" json:"Version,omitempty"` + // PayloadLength is an object payload length + PayloadLength uint64 `protobuf:"varint,2,opt,name=PayloadLength,proto3" json:"PayloadLength,omitempty"` + // ID is an object identifier, is a valid UUIDv4 + ID ID `protobuf:"bytes,3,opt,name=ID,proto3,customtype=ID" json:"ID"` + // OwnerID is a wallet address + OwnerID OwnerID `protobuf:"bytes,4,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` + // CID is a SHA256 hash of the container structure (container identifier) + CID CID `protobuf:"bytes,5,opt,name=CID,proto3,customtype=CID" json:"CID"` + // CreatedAt is a timestamp of object creation CreatedAt CreationPoint `protobuf:"bytes,6,opt,name=CreatedAt,proto3" json:"CreatedAt"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -510,7 +532,9 @@ func (m *SystemHeader) GetCreatedAt() CreationPoint { } type CreationPoint struct { - UnixTime int64 `protobuf:"varint,1,opt,name=UnixTime,proto3" json:"UnixTime,omitempty"` + // UnixTime is a date of creation in unixtime format + UnixTime int64 `protobuf:"varint,1,opt,name=UnixTime,proto3" json:"UnixTime,omitempty"` + // Epoch is a date of creation in NeoFS epochs Epoch uint64 `protobuf:"varint,2,opt,name=Epoch,proto3" json:"Epoch,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -561,7 +585,9 @@ func (m *CreationPoint) GetEpoch() uint64 { } type IntegrityHeader struct { - HeadersChecksum []byte `protobuf:"bytes,1,opt,name=HeadersChecksum,proto3" json:"HeadersChecksum,omitempty"` + // HeadersChecksum is a checksum of all above headers in the object + HeadersChecksum []byte `protobuf:"bytes,1,opt,name=HeadersChecksum,proto3" json:"HeadersChecksum,omitempty"` + // ChecksumSignature is an user's signature of checksum to verify if it is correct ChecksumSignature []byte `protobuf:"bytes,2,opt,name=ChecksumSignature,proto3" json:"ChecksumSignature,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -612,11 +638,13 @@ func (m *IntegrityHeader) GetChecksumSignature() []byte { } type Link struct { - Type Link_Type `protobuf:"varint,1,opt,name=type,proto3,enum=object.Link_Type" json:"type,omitempty"` - ID ID `protobuf:"bytes,2,opt,name=ID,proto3,customtype=ID" json:"ID"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Type of link + Type Link_Type `protobuf:"varint,1,opt,name=type,proto3,enum=object.Link_Type" json:"type,omitempty"` + // ID is an object identifier, is a valid UUIDv4 + ID ID `protobuf:"bytes,2,opt,name=ID,proto3,customtype=ID" json:"ID"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *Link) Reset() { *m = Link{} } @@ -656,6 +684,7 @@ func (m *Link) GetType() Link_Type { } type Transform struct { + // Type of object transformation Type Transform_Type `protobuf:"varint,1,opt,name=type,proto3,enum=object.Transform_Type" json:"type,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -699,12 +728,15 @@ func (m *Transform) GetType() Transform_Type { } type Object struct { - SystemHeader SystemHeader `protobuf:"bytes,1,opt,name=SystemHeader,proto3" json:"SystemHeader"` - Headers []Header `protobuf:"bytes,2,rep,name=Headers,proto3" json:"Headers"` - Payload []byte `protobuf:"bytes,3,opt,name=Payload,proto3" json:"Payload,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // SystemHeader describes system header + SystemHeader SystemHeader `protobuf:"bytes,1,opt,name=SystemHeader,proto3" json:"SystemHeader"` + // Headers describes a set of an extended headers + Headers []Header `protobuf:"bytes,2,rep,name=Headers,proto3" json:"Headers"` + // Payload is an object's payload + Payload []byte `protobuf:"bytes,3,opt,name=Payload,proto3" json:"Payload,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *Object) Reset() { *m = Object{} } @@ -758,8 +790,11 @@ func (m *Object) GetPayload() []byte { } type StorageGroup struct { - ValidationDataSize uint64 `protobuf:"varint,1,opt,name=ValidationDataSize,proto3" json:"ValidationDataSize,omitempty"` - ValidationHash Hash `protobuf:"bytes,2,opt,name=ValidationHash,proto3,customtype=Hash" json:"ValidationHash"` + // ValidationDataSize is size of the all object's payloads included into storage group + ValidationDataSize uint64 `protobuf:"varint,1,opt,name=ValidationDataSize,proto3" json:"ValidationDataSize,omitempty"` + // ValidationHash is homomorphic hash of all object's payloads included into storage group + ValidationHash Hash `protobuf:"bytes,2,opt,name=ValidationHash,proto3,customtype=Hash" json:"ValidationHash"` + // Lifetime is time until storage group is valid Lifetime *StorageGroup_Lifetime `protobuf:"bytes,3,opt,name=lifetime,proto3" json:"lifetime,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -810,11 +845,13 @@ func (m *StorageGroup) GetLifetime() *StorageGroup_Lifetime { } type StorageGroup_Lifetime struct { - Unit StorageGroup_Lifetime_Unit `protobuf:"varint,1,opt,name=unit,proto3,enum=object.StorageGroup_Lifetime_Unit" json:"unit,omitempty"` - Value int64 `protobuf:"varint,2,opt,name=Value,proto3" json:"Value,omitempty"` - XXX_NoUnkeyedLiteral struct{} `json:"-"` - XXX_unrecognized []byte `json:"-"` - XXX_sizecache int32 `json:"-"` + // Unit is lifetime type + Unit StorageGroup_Lifetime_Unit `protobuf:"varint,1,opt,name=unit,proto3,enum=object.StorageGroup_Lifetime_Unit" json:"unit,omitempty"` + // Value for lifetime + Value int64 `protobuf:"varint,2,opt,name=Value,proto3" json:"Value,omitempty"` + XXX_NoUnkeyedLiteral struct{} `json:"-"` + XXX_unrecognized []byte `json:"-"` + XXX_sizecache int32 `json:"-"` } func (m *StorageGroup_Lifetime) Reset() { *m = StorageGroup_Lifetime{} } diff --git a/query/types.pb.go b/query/types.pb.go index 8fa3dbe..7223bf8 100644 --- a/query/types.pb.go +++ b/query/types.pb.go @@ -23,11 +23,12 @@ var _ = math.Inf // proto package needs to be updated. const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package -// Type can be Exact or Regex type Filter_Type int32 const ( + // Exact sets when value of filter should be equal to the header value Filter_Exact Filter_Type = 0 + // Regex sets when value of filter should match the header value by the regular expression Filter_Regex Filter_Type = 1 ) diff --git a/refs/types.pb.go b/refs/types.pb.go index 87f3fce..2ccde2f 100644 --- a/refs/types.pb.go +++ b/refs/types.pb.go @@ -25,7 +25,7 @@ const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package // Address of object (container id + object id) type Address struct { - // ObjectID is an object identifier + // ObjectID is an object identifier, valid UUIDv4 represented in bytes ObjectID ObjectID `protobuf:"bytes,1,opt,name=ObjectID,proto3,customtype=ObjectID" json:"ObjectID"` // CID is container identifier CID CID `protobuf:"bytes,2,opt,name=CID,proto3,customtype=CID" json:"CID"` diff --git a/session/service.pb.go b/session/service.pb.go index 4961b0d..b99b611 100644 --- a/session/service.pb.go +++ b/session/service.pb.go @@ -238,6 +238,16 @@ const _ = grpc.SupportPackageIsVersion4 // // For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream. type SessionClient interface { + // 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`. Create(ctx context.Context, opts ...grpc.CallOption) (Session_CreateClient, error) } @@ -282,6 +292,16 @@ func (x *sessionCreateClient) Recv() (*CreateResponse, error) { // SessionServer is the server API for Session service. type SessionServer interface { + // 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`. Create(Session_CreateServer) error } diff --git a/session/types.pb.go b/session/types.pb.go index d39961e..f597612 100644 --- a/session/types.pb.go +++ b/session/types.pb.go @@ -24,9 +24,9 @@ var _ = math.Inf const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package type VerificationHeader struct { - // Session public key + // PublicKey is a session public key PublicKey []byte `protobuf:"bytes,1,opt,name=PublicKey,proto3" json:"PublicKey,omitempty"` - // Session public key signature. Signed by trusted side + // KeySignature is a session public key signature. Signed by trusted side KeySignature []byte `protobuf:"bytes,2,opt,name=KeySignature,proto3" json:"KeySignature,omitempty"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"` @@ -80,17 +80,17 @@ func (m *VerificationHeader) GetKeySignature() []byte { type Token struct { // Header carries verification data of session key Header VerificationHeader `protobuf:"bytes,1,opt,name=Header,proto3" json:"Header"` - // Owner of manipulation object + // OwnerID is an owner of manipulation object OwnerID OwnerID `protobuf:"bytes,2,opt,name=OwnerID,proto3,customtype=OwnerID" json:"OwnerID"` - // Initial epoch of token lifetime + // FirstEpoch is an initial epoch of token lifetime FirstEpoch uint64 `protobuf:"varint,3,opt,name=FirstEpoch,proto3" json:"FirstEpoch,omitempty"` - // Last epoch of token lifetime + // LastEpoch is a last epoch of token lifetime LastEpoch uint64 `protobuf:"varint,4,opt,name=LastEpoch,proto3" json:"LastEpoch,omitempty"` - // ID of manipulation object + // ObjectID is an object identifier of manipulation object ObjectID []ObjectID `protobuf:"bytes,5,rep,name=ObjectID,proto3,customtype=ObjectID" json:"ObjectID"` - // Token signature. Signed by owner of manipulation object + // Signature is a token signature, signed by owner of manipulation object Signature []byte `protobuf:"bytes,6,opt,name=Signature,proto3" json:"Signature,omitempty"` - // Token ID (UUID) + // ID is a token identifier. valid UUIDv4 represented in bytes ID TokenID `protobuf:"bytes,7,opt,name=ID,proto3,customtype=TokenID" json:"ID"` XXX_NoUnkeyedLiteral struct{} `json:"-"` XXX_unrecognized []byte `json:"-"`