carpawell/frostfs-api
1
0
Fork 0
forked from TrueCloudLab/frostfs-api
Code Issues Pull requests Projects Releases Packages Wiki Activity

[nspcc-dev/neofs-node#151] Clarify $Object:ROOT filter description

Browse source 
* 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 <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2020-11-09 13:03:49 +03:00 committed by Stanislav Bogatyrev
parent 9a319905be
commit 2613670553
1 changed files with 11 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
object/service.proto
View file

@ -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