Merge pull request #297 from nspcc-dev/feat/tombstones-structure

Feat/tombstones structure
nspcc-dev · Apr 23, 2024 · d42e6a0 · d42e6a0
2 parents 36da36e + ef8bc00
commit d42e6a0
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/proto-docs/tombstone.md b/proto-docs/tombstone.md
@@ -32,8 +32,8 @@ purged from the NeoFS network.
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | expiration_epoch | [uint64](#uint64) |  | Last NeoFS epoch number of the tombstone lifetime. It's set by the tombstone creator depending on the current NeoFS network settings. DEPRECATED. Field ignored by servers, set corresponding object attribute `__NEOFS__EXPIRATION_EPOCH` only. |
-| split_id | [bytes](#bytes) |  | 16 byte UUID used to identify the split object hierarchy parts. Must be unique inside a container. All objects participating in the split must have the same `split_id` value. |
-| members | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of objects to be deleted. |
+| split_id | [bytes](#bytes) |  | 16 byte UUID used to identify the split object hierarchy parts. Must be unique inside a container. All objects participating in the split must have the same `split_id` value. DEPRECATED. The field is ignored by servers. |
+| members | [neo.fs.v2.refs.ObjectID](#neo.fs.v2.refs.ObjectID) | repeated | List of objects to be deleted. IDs should be either: 1. Root object IDs (objects that are not split OR parent objects) 2. Children IDs for unfinished objects that does not have LINK objects (garbage collecting). |
 
  <!-- end messages -->
 

diff --git a/tombstone/types.proto b/tombstone/types.proto
@@ -19,8 +19,12 @@ message Tombstone {
   // 16 byte UUID used to identify the split object hierarchy parts. Must be
   // unique inside a container. All objects participating in the split must
   // have the same `split_id` value.
+  // DEPRECATED. The field is ignored by servers.
   bytes split_id = 2 [json_name = "splitID"];
 
   // List of objects to be deleted.
+  // IDs should be either:
+  //  1. Root object IDs (objects that are not split OR parent objects)
+  //  2. Children IDs for unfinished objects that does not have LINK objects (garbage collecting).
   repeated neo.fs.v2.refs.ObjectID members = 3 [json_name = "members"];
 }