[#16] container, object: Regenerate service comments

Signed-off-by: Pavel Karpy <p.karpy@yadro.com>
pull/16/head
Pavel Karpy 2023-04-07 15:32:05 +03:00
parent e022a2b831
commit e6522d62a8
2 changed files with 318 additions and 320 deletions

View File

@ -30,11 +30,11 @@ type ObjectServiceClient interface {
// keeping the receiving order.
//
// Extended headers can change `Get` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
// the latest one otherwise) of Network Map to find an object until the depth
@ -65,7 +65,7 @@ type ObjectServiceClient interface {
// Chunk messages SHOULD be sent in the direct order of fragmentation.
//
// Extended headers can change `Put` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH \
// * [ __SYSTEM__NETMAP_EPOCH \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
@ -88,7 +88,6 @@ type ObjectServiceClient interface {
// object storage container not found;
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
// (for trusted object preparation) session private key does not exist or has
//
// been deleted;
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
// provided session token has expired.
@ -97,7 +96,7 @@ type ObjectServiceClient interface {
// guarantee. Object will be marked for removal and deleted eventually.
//
// Extended headers can change `Delete` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
@ -122,7 +121,7 @@ type ObjectServiceClient interface {
// the very minimal information will be returned instead.
//
// Extended headers can change `Head` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
@ -149,7 +148,7 @@ type ObjectServiceClient interface {
// Specification section for more details.
//
// Extended headers can change `Search` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
@ -173,11 +172,11 @@ type ObjectServiceClient interface {
// order.
//
// Extended headers can change `GetRange` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
@ -207,11 +206,11 @@ type ObjectServiceClient interface {
// the request. Note that hash is calculated for XORed data.
//
// Extended headers can change `GetRangeHash` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
@ -412,11 +411,11 @@ type ObjectServiceServer interface {
// keeping the receiving order.
//
// Extended headers can change `Get` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions (starting from `__SYSTEM__NETMAP_EPOCH` (`__NEOFS__NETMAP_EPOCH` is deprecated) if specified or
// the latest one otherwise) of Network Map to find an object until the depth
@ -447,7 +446,7 @@ type ObjectServiceServer interface {
// Chunk messages SHOULD be sent in the direct order of fragmentation.
//
// Extended headers can change `Put` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH \
// * [ __SYSTEM__NETMAP_EPOCH \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requsted version of Network Map for object placement
// calculation.
@ -470,7 +469,6 @@ type ObjectServiceServer interface {
// object storage container not found;
// - **TOKEN_NOT_FOUND** (4096, SECTION_SESSION): \
// (for trusted object preparation) session private key does not exist or has
//
// been deleted;
// - **TOKEN_EXPIRED** (4097, SECTION_SESSION): \
// provided session token has expired.
@ -479,7 +477,7 @@ type ObjectServiceServer interface {
// guarantee. Object will be marked for removal and deleted eventually.
//
// Extended headers can change `Delete` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
@ -504,7 +502,7 @@ type ObjectServiceServer interface {
// the very minimal information will be returned instead.
//
// Extended headers can change `Head` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
@ -531,7 +529,7 @@ type ObjectServiceServer interface {
// Specification section for more details.
//
// Extended headers can change `Search` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
@ -555,11 +553,11 @@ type ObjectServiceServer interface {
// order.
//
// Extended headers can change `GetRange` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.
@ -589,11 +587,11 @@ type ObjectServiceServer interface {
// the request. Note that hash is calculated for XORed data.
//
// Extended headers can change `GetRangeHash` behaviour:
// - [ __SYSTEM__NETMAP_EPOCH ] \
// * [ __SYSTEM__NETMAP_EPOCH ] \
// (`__NEOFS__NETMAP_EPOCH` is deprecated) \
// Will use the requested version of Network Map for object placement
// calculation.
// - [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// * [ __SYSTEM__NETMAP_LOOKUP_DEPTH ] \
// (`__NEOFS__NETMAP_LOOKUP_DEPTH` is deprecated) \
// Will try older versions of Network Map to find an object until the depth
// limit is reached.