From 261367055323a2a40a6b4bc225e1c1d1b7331e02 Mon Sep 17 00:00:00 2001 From: Stanislav Bogatyrev Date: Mon, 9 Nov 2020 13:03:49 +0300 Subject: [PATCH] [nspcc-dev/neofs-node#151] Clarify $Object:ROOT filter description * It's expected by app developers that ROOT filter will return the list of objects created by user, without supplementary objects like split object parts, tombstones and storage groups. * Rename LEAF to PHY as it's purpose it to return physically existing objects. Signed-off-by: Stanislav Bogatyrev --- object/service.proto | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/object/service.proto b/object/service.proto index 14eabba..c4f6931 100644 --- a/object/service.proto +++ b/object/service.proto @@ -327,11 +327,17 @@ message SearchRequest { // properties: // // * $Object:ROOT \ - // With the `value` set to `true` checks if an object is a top object in a - // split hierarchy. With other values returns non-root objects. - // * $Object:LEAF \ - // With the `value` set to `true` checks if an object is a leaf in a split - // hierarchy. With other values returns non-leaf objects. + // Returns only `REGULAR` type objects that are not split or are the top + // level root objects in a split hierarchy. This includes objects not + // present physically, like large objects split into smaller objects + // without separate top-level root object. Other type objects like + // StorageGroups and Tombstones will not be shown. This filter may be + // useful for listing objects like `ls` command of some virtual file + // system. This filter is activated if the `key` exists, disregarding the + // value and matcher type. + // * $Object:PHY \ + // Returns only objects physically stored in the system. This filter is + // activated if the `key` exists, disregarding the value and matcher type. // * $Object:CHILDFREE \ // With the `value` set to `true` checks if an object has empty // children list in `Split` header. With other values returns