diff --git a/website/docs/reference/search-operators.md b/website/docs/reference/search-operators.md new file mode 100644 index 0000000000..3ca81e67ee --- /dev/null +++ b/website/docs/reference/search-operators.md @@ -0,0 +1,63 @@ +--- +title: Search with filters/operators +--- + +:::info Availability + +Search with filters/operators was introduced in **Unleash 5.9**. + +::: + +Search with filters/operators is a feature that allows users to conduct flexible data filtering. This feature is currently available on two specific pages: the Global Features Page and the Project Page. + +## Search Bar + +**Location**: The search bar is located at the top of the Global Features Page and the Project Page. + +**Functionality**: It enables users to conduct searches for features using text. This is a **full-text search** that includes both feature names and feature descriptions. + +**Multiple Keywords**: To search for multiple keywords, separate them with a comma. When searching with multiple keywords, there is effectively an **OR** condition between them, so the search will match items that contain either of the keywords. However, be aware that texts containing commas cannot be effectively searched, as the comma is used as a separator. + +![The search bar, using multiple keywords](/img/search-bar.png) + + +## Search Filters Supported + +The search functionality supports five filters: + +1. **Created Date**: Allows filtering based on the creation date of features. +2. **Project**: Allows filtering by specific projects. +3. **Segment**: Allows filtering based on segments. +4. **State**: Allows filtering by the state of features. +5. **Tags**: Allows filtering using selected tags. + +### Filter Flexibility + +- **Created Date**: Supports single value selection with two operators: + - *On or After*: Filters features created on or after a specific date. + - *Is Before*: Filters features created before a specific date. + +- **Project**: Allows single or multiple value selections with these operators: + - *Is*: Filters features belonging to a specific project. + - *Is Not*: Excludes features from a specific project. + - *Is Any Of*: (For multiple selections) Includes features from any of the selected projects. + - *Is None Of*: (For multiple selections) Excludes features from all the selected projects. + +- **Segment** and **Tags**: These filters offer similar operators: + - *Include*: Filters features that include specific segments or tags. + - *Do Not Include*: Excludes features with specific segments or tags. + - *Include All Of*: (For multiple selections) Filters features that include all specified segments or tags. + - *Include Any Of*: (For multiple selections) Filters features that include any of the specified segments or tags. + - *Exclude If Any Of*: (For multiple selections) Excludes features if they include any of the specified segments or tags. + - *Exclude All*: (For multiple selections) Excludes features that include all specified segments or tags. + +- **State**: Supports two values—Active or Stale—with two operators: + - *Is*: Filters features that are either active or stale. + - *Is Not*: Excludes features that are either active or stale. + +![The search filters, using operators](/img/search-operators.png) + +## API Support for Search + +In addition to the user interface, Search with Operators is also supported through the API. All the filters and operators function identically to their counterparts in the UI, ensuring a consistent experience between the API and user interface. +Refer to [Search API](../reference/api/unleash/search-features) for full details. diff --git a/website/sidebars.js b/website/sidebars.js index ad74e3982e..ccc22319bc 100644 --- a/website/sidebars.js +++ b/website/sidebars.js @@ -182,6 +182,7 @@ module.exports = { 'reference/projects', 'reference/project-collaboration-mode', 'reference/rbac', + 'reference/search-operators', 'reference/segments', 'reference/service-accounts', 'reference/sso', diff --git a/website/static/img/img.png b/website/static/img/img.png deleted file mode 100644 index 4b2c08d786..0000000000 Binary files a/website/static/img/img.png and /dev/null differ diff --git a/website/static/img/search-bar.png b/website/static/img/search-bar.png new file mode 100644 index 0000000000..737f568d4b Binary files /dev/null and b/website/static/img/search-bar.png differ diff --git a/website/static/img/search-operators.png b/website/static/img/search-operators.png new file mode 100644 index 0000000000..d3b89427a9 Binary files /dev/null and b/website/static/img/search-operators.png differ