[#135] Clarify empty search filter behaviour

It may be confusing for the user to get all types of objects as the
result of a search with no filters set. Human users may expect to see
only the objects intended for direct manipulation by humans.

Signed-off-by: Stanislav Bogatyrev <stanislav@nspcc.ru>
This commit is contained in:
Stanislav Bogatyrev 2021-02-20 11:10:36 +03:00 committed by Alex Vanin
parent 1f89c9a0d8
commit 82f2b4cbc1

View file

@ -308,6 +308,11 @@ message SearchRequest {
// Filter structure checks if object header field or attribute content
// matches a value.
//
// If no filters set, search request will return all objects of the
// container, including Regular object, Tombstones and Storage Group
// objects. Most human users expect to get only object they can directly
// work with. In that case the `$Object:ROOT` filter should be used.
//
// By default `key` field refers to the corresponding object's `Attribute`.
// Some Object's header fields can also be accessed by adding `$Object:`
// prefix to the name. Here is the list of fields available via this prefix: