From 603fbbcc2009ba1e1cff66669df266a525d2aeb7 Mon Sep 17 00:00:00 2001 From: Gian Merlino Date: Thu, 2 Jun 2016 19:03:40 -0700 Subject: [PATCH] Fix docs for "contains" search spec. (#3066) --- docs/content/querying/filters.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/content/querying/filters.md b/docs/content/querying/filters.md index bebdd93c62f..48b18ce6879 100644 --- a/docs/content/querying/filters.md +++ b/docs/content/querying/filters.md @@ -273,6 +273,14 @@ Now suppose that the lower bound is `110` the filter will not match (`110 < 10K` #### Search Query Spec +##### Contains + +|property|description|required?| +|--------|-----------|---------| +|type|This String should always be "contains".|yes| +|value|A String value to run the search over.|yes| +|caseSensitive|Whether two string should be compared as case sensitive or not|no (default == false)| + ##### Insensitive Contains |property|description|required?| @@ -280,6 +288,9 @@ Now suppose that the lower bound is `110` the filter will not match (`110 < 10K` |type|This String should always be "insensitive_contains".|yes| |value|A String value to run the search over.|yes| +Note that an "insensitive_contains" search is equivalent to a "contains" search with "caseSensitive": false (or not +provided). + ##### Fragment |property|description|required?| @@ -288,15 +299,6 @@ Now suppose that the lower bound is `110` the filter will not match (`110 < 10K` |values|A JSON array of String values to run the search over.|yes| |caseSensitive|Whether strings should be compared as case sensitive or not. Default: false(insensitive)|no| -##### Contains - -|property|description|required?| -|--------|-----------|---------| -|type|This String should always be "contains".|yes| -|value|A String value to run the search over.|yes| -|caseSensitive|Whether two string should be compared as case sensitive or not|yes| - - ### Filtering with Extraction Functions Some filters optionally support the use of extraction functions. An extraction function is defined by setting the "extractionFn" field on a filter. @@ -329,4 +331,4 @@ The following matches dimension values in `[product_1, product_3, product_5]` fo } } } -``` \ No newline at end of file +```