[#10] Generate api

Signed-off-by: Denis Kirillov <d.kirillov@yadro.com>
This commit is contained in:
Denis Kirillov 2023-03-06 14:59:51 +03:00
parent ec0d0274fa
commit c46cd37f71
8 changed files with 39 additions and 39 deletions

View file

@ -30,11 +30,11 @@ type ObjectServiceClient interface {
// keeping the receiving order.
//
// Extended headers can change `Get` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
// - __NEOFS__NETMAP_LOOKUP_DEPTH \
// Will try older versions (starting from `__NEOFS__NETMAP_EPOCH` if specified or
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions (starting from `__NEOFS__NETMAP_EPOCH`/`__FROSTFS__NETMAP_EPOCH` if specified or
// the latest one otherwise) of Network Map to find an object until the depth
// limit is reached.
//
@ -63,7 +63,7 @@ type ObjectServiceClient interface {
// Chunk messages SHOULD be sent in the direct order of fragmentation.
//
// Extended headers can change `Put` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -94,7 +94,7 @@ type ObjectServiceClient interface {
// guarantee. Object will be marked for removal and deleted eventually.
//
// Extended headers can change `Delete` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -118,7 +118,7 @@ type ObjectServiceClient interface {
// the very minimal information will be returned instead.
//
// Extended headers can change `Head` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -144,7 +144,7 @@ type ObjectServiceClient interface {
// Specification section for more details.
//
// Extended headers can change `Search` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -167,10 +167,10 @@ type ObjectServiceClient interface {
// order.
//
// Extended headers can change `GetRange` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
// - __NEOFS__NETMAP_LOOKUP_DEPTH \
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//
@ -199,10 +199,10 @@ type ObjectServiceClient interface {
// the request. Note that hash is calculated for XORed data.
//
// Extended headers can change `GetRangeHash` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
// - __NEOFS__NETMAP_LOOKUP_DEPTH \
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//
@ -402,11 +402,11 @@ type ObjectServiceServer interface {
// keeping the receiving order.
//
// Extended headers can change `Get` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
// - __NEOFS__NETMAP_LOOKUP_DEPTH \
// Will try older versions (starting from `__NEOFS__NETMAP_EPOCH` if specified or
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions (starting from `__NEOFS__NETMAP_EPOCH`/`__FROSTFS__NETMAP_EPOCH` if specified or
// the latest one otherwise) of Network Map to find an object until the depth
// limit is reached.
//
@ -435,7 +435,7 @@ type ObjectServiceServer interface {
// Chunk messages SHOULD be sent in the direct order of fragmentation.
//
// Extended headers can change `Put` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -466,7 +466,7 @@ type ObjectServiceServer interface {
// guarantee. Object will be marked for removal and deleted eventually.
//
// Extended headers can change `Delete` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -490,7 +490,7 @@ type ObjectServiceServer interface {
// the very minimal information will be returned instead.
//
// Extended headers can change `Head` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -516,7 +516,7 @@ type ObjectServiceServer interface {
// Specification section for more details.
//
// Extended headers can change `Search` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
//
@ -539,10 +539,10 @@ type ObjectServiceServer interface {
// order.
//
// Extended headers can change `GetRange` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
// - __NEOFS__NETMAP_LOOKUP_DEPTH \
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//
@ -571,10 +571,10 @@ type ObjectServiceServer interface {
// the request. Note that hash is calculated for XORed data.
//
// Extended headers can change `GetRangeHash` behaviour:
// - __NEOFS__NETMAP_EPOCH \
// - [ __NEOFS__NETMAP_EPOCH | __FROSTFS__NETMAP_EPOCH ] \
// Will use the requsted version of Network Map for object placement
// calculation.
// - __NEOFS__NETMAP_LOOKUP_DEPTH \
// - [ __NEOFS__NETMAP_LOOKUP_DEPTH | __FROSTFS__NETMAP_LOOKUP_DEPTH ] \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
//

View file

@ -556,19 +556,19 @@ func (x *SplitInfo) GetLink() *grpc.ObjectID {
// Objects with duplicated attribute names or attributes with empty values
// will be considered invalid.
//
// There are some "well-known" attributes starting with `__NEOFS__` prefix
// There are some "well-known" attributes starting with `__NEOFS__`/`__FROSTFS__` prefix
// that affect system behaviour:
//
// - __NEOFS__UPLOAD_ID \
// - [ __NEOFS__UPLOAD_ID | __FROSTFS__UPLOAD_ID ] \
// Marks smaller parts of a split bigger object
// - __NEOFS__EXPIRATION_EPOCH \
// - [ __NEOFS__EXPIRATION_EPOCH | __FROSTFS__EXPIRATION_EPOCH ] \
// Tells GC to delete object after that epoch
// - __NEOFS__TICK_EPOCH \
// - [ __NEOFS__TICK_EPOCH | __FROSTFS__TICK_EPOCH ] \
// Decimal number that defines what epoch must produce
// object notification with UTF-8 object address in a
// body (`0` value produces notification right after
// object put)
// - __NEOFS__TICK_TOPIC \
// - [ __NEOFS__TICK_TOPIC | __FROSTFS__TICK_TOPIC ] \
// UTF-8 string topic ID that is used for object notification
//
// And some well-known attributes used by applications only: