forked from TrueCloudLab/frostfs-api-go
docs: add deprecation notice for epoch and ttl fields
This commit is contained in:
parent
15b997bdb5
commit
3d445aeb0b
5 changed files with 24 additions and 0 deletions
|
@ -19,6 +19,7 @@ message BalanceRequest {
|
||||||
// OwnerID is a wallet address
|
// OwnerID is a wallet address
|
||||||
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 2;
|
uint32 TTL = 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -38,6 +38,7 @@ message GetRequest {
|
||||||
// OwnerID is a wallet address
|
// OwnerID is a wallet address
|
||||||
bytes OwnerID = 2 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
bytes OwnerID = 2 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 3;
|
uint32 TTL = 3;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -58,6 +59,7 @@ message PutRequest {
|
||||||
// Signature is a signature of the sent request
|
// Signature is a signature of the sent request
|
||||||
bytes Signature = 5;
|
bytes Signature = 5;
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 6;
|
uint32 TTL = 6;
|
||||||
}
|
}
|
||||||
message PutResponse {
|
message PutResponse {
|
||||||
|
@ -69,6 +71,7 @@ message ListRequest {
|
||||||
// OwnerID is a wallet address
|
// OwnerID is a wallet address
|
||||||
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 2;
|
uint32 TTL = 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -87,6 +90,7 @@ message DeleteRequest {
|
||||||
// Signature is a signature of the sent request
|
// Signature is a signature of the sent request
|
||||||
bytes Signature = 4;
|
bytes Signature = 4;
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 5;
|
uint32 TTL = 5;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -21,5 +21,6 @@ message Request {
|
||||||
// Info contains information about node
|
// Info contains information about node
|
||||||
bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false];
|
bootstrap.NodeInfo info = 2 [(gogoproto.nullable) = false];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 3;
|
uint32 TTL = 3;
|
||||||
}
|
}
|
||||||
|
|
|
@ -43,6 +43,7 @@ message PutRequest {
|
||||||
bytes Signature = 5;
|
bytes Signature = 5;
|
||||||
|
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 6;
|
uint32 TTL = 6;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -56,6 +57,7 @@ message DeleteRequest {
|
||||||
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
||||||
|
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 2;
|
uint32 TTL = 2;
|
||||||
|
|
||||||
// Signature of the container owner
|
// Signature of the container owner
|
||||||
|
@ -72,6 +74,7 @@ message GetRequest {
|
||||||
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
bytes CID = 1 [(gogoproto.customtype) = "CID", (gogoproto.nullable) = false];
|
||||||
|
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 2;
|
uint32 TTL = 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -85,6 +88,7 @@ message ListRequest {
|
||||||
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
bytes OwnerID = 1 [(gogoproto.customtype) = "OwnerID", (gogoproto.nullable) = false];
|
||||||
|
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 2;
|
uint32 TTL = 2;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
@ -53,10 +53,12 @@ service Service {
|
||||||
|
|
||||||
message GetRequest {
|
message GetRequest {
|
||||||
// Epoch is set by user to 0, node set epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Address of object (container id + object id)
|
// Address of object (container id + object id)
|
||||||
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 3;
|
uint32 TTL = 3;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -72,10 +74,12 @@ message GetResponse {
|
||||||
message PutRequest {
|
message PutRequest {
|
||||||
message PutHeader {
|
message PutHeader {
|
||||||
// Epoch is set by user to 0, node set epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Object with at least container id and owner id fields
|
// Object with at least container id and owner id fields
|
||||||
Object Object = 2;
|
Object Object = 2;
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 3;
|
uint32 TTL = 3;
|
||||||
// Token with session public key and user's signature
|
// Token with session public key and user's signature
|
||||||
session.Token Token = 4;
|
session.Token Token = 4;
|
||||||
|
@ -95,12 +99,14 @@ message PutResponse {
|
||||||
}
|
}
|
||||||
message DeleteRequest {
|
message DeleteRequest {
|
||||||
// Epoch is set by user to 0, node set epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Address of object (container id + object id)
|
// Address of object (container id + object id)
|
||||||
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
||||||
// OwnerID is a wallet address
|
// OwnerID is a wallet address
|
||||||
bytes OwnerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "OwnerID"];
|
bytes OwnerID = 3 [(gogoproto.nullable) = false, (gogoproto.customtype) = "OwnerID"];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 4;
|
uint32 TTL = 4;
|
||||||
// Token with session public key and user's signature
|
// Token with session public key and user's signature
|
||||||
session.Token Token = 5;
|
session.Token Token = 5;
|
||||||
|
@ -112,12 +118,14 @@ message DeleteResponse {}
|
||||||
|
|
||||||
message HeadRequest {
|
message HeadRequest {
|
||||||
// Epoch should be empty on user side, node sets epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Address of object (container id + object id)
|
// Address of object (container id + object id)
|
||||||
refs.Address Address = 2 [(gogoproto.nullable) = false, (gogoproto.customtype) = "Address"];
|
refs.Address Address = 2 [(gogoproto.nullable) = false, (gogoproto.customtype) = "Address"];
|
||||||
// FullHeaders can be set true for extended headers in the object
|
// FullHeaders can be set true for extended headers in the object
|
||||||
bool FullHeaders = 3;
|
bool FullHeaders = 3;
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 4;
|
uint32 TTL = 4;
|
||||||
}
|
}
|
||||||
message HeadResponse {
|
message HeadResponse {
|
||||||
|
@ -127,6 +135,7 @@ message HeadResponse {
|
||||||
|
|
||||||
message SearchRequest {
|
message SearchRequest {
|
||||||
// Epoch is set by user to 0, node set epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Version of search query format
|
// Version of search query format
|
||||||
uint32 Version = 2;
|
uint32 Version = 2;
|
||||||
|
@ -135,6 +144,7 @@ message SearchRequest {
|
||||||
// Query in the binary serialized format
|
// Query in the binary serialized format
|
||||||
bytes Query = 4;
|
bytes Query = 4;
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 5;
|
uint32 TTL = 5;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -145,12 +155,14 @@ message SearchResponse {
|
||||||
|
|
||||||
message GetRangeRequest {
|
message GetRangeRequest {
|
||||||
// Epoch is set by user to 0, node set epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Address of object (container id + object id)
|
// Address of object (container id + object id)
|
||||||
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
||||||
// Ranges of object's payload to return
|
// Ranges of object's payload to return
|
||||||
repeated Range Ranges = 3 [(gogoproto.nullable) = false];
|
repeated Range Ranges = 3 [(gogoproto.nullable) = false];
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 4;
|
uint32 TTL = 4;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -161,6 +173,7 @@ message GetRangeResponse {
|
||||||
|
|
||||||
message GetRangeHashRequest {
|
message GetRangeHashRequest {
|
||||||
// Epoch is set by user to 0, node set epoch to the actual value
|
// 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;
|
uint64 Epoch = 1;
|
||||||
// Address of object (container id + object id)
|
// Address of object (container id + object id)
|
||||||
refs.Address Address = 2 [(gogoproto.nullable) = false];
|
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
|
// Salt is used to XOR object's payload ranges before hashing, it can be nil
|
||||||
bytes Salt = 4;
|
bytes Salt = 4;
|
||||||
// TTL must be larger than zero, it decreased in every neofs-node
|
// TTL must be larger than zero, it decreased in every neofs-node
|
||||||
|
// Deprecated: will be replaced with RequestMetaHeader (see develop branch)
|
||||||
uint32 TTL = 5;
|
uint32 TTL = 5;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue