Skip to content

Commit 714489a

Browse files
q-litzlerq-litzler
committed
Update filters documentation
1 parent 343f184 commit 714489a

File tree

12 files changed

+91
-91
lines changed

12 files changed

+91
-91
lines changed

‎src/commonTest/kotlin/documentation/guides/optimize/intent/GuideDynamicFiltering.kt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ internal class GuideDynamicFiltering {
3636
Consequence(
3737
edits = edits { +"gluten-free" },
3838
query = query {
39-
filters { and { +!facet("allergens", "gluten") } }
39+
filters { and { facet("allergens", "gluten", isNegated = true) } }
4040
}
4141
)
4242
)
@@ -58,8 +58,8 @@ internal class GuideDynamicFiltering {
5858
query = query {
5959
filters {
6060
orTag {
61-
+tag("low-carb")
62-
+tag("low-fat")
61+
tag("low-carb")
62+
tag("low-fat")
6363
}
6464
}
6565
}
@@ -96,7 +96,7 @@ internal class GuideDynamicFiltering {
9696
query = query {
9797
optionalFilters {
9898
and {
99-
+facet("can_deliver_quickly", "true")
99+
facet("can_deliver_quickly", "true")
100100
}
101101
}
102102
}

‎src/commonTest/kotlin/documentation/guides/results/filtering/GuideFilterArray.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ internal class GuideFilterArray {
3333
val query = query("harry") {
3434
filters {
3535
and {
36-
+facet("categories", "politics")
37-
+facet("store", "Gibert Joseph Saint-Michel")
36+
facet("categories", "politics")
37+
facet("store", "Gibert Joseph Saint-Michel")
3838
}
3939
}
4040
}

‎src/commonTest/kotlin/documentation/guides/results/filtering/GuideFilterBoolean.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ internal class GuideFilterBoolean {
1717
val query = query("query") {
1818
filters {
1919
and {
20-
+facet("is_available", true)
20+
facet("is_available", true)
2121
}
2222
}
2323
}

‎src/commonTest/kotlin/documentation/guides/results/filtering/GuideFilterDate.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ internal class GuideFilterDate {
1717
val query = query("query") {
1818
filters {
1919
and {
20-
+comparison("date_timestamp", Greater, 1538352000000)
20+
comparison("date_timestamp", Greater, 1538352000000)
2121
}
2222
}
2323
}
@@ -32,7 +32,7 @@ internal class GuideFilterDate {
3232
val query = query("query") {
3333
filters {
3434
and {
35-
+range("date_timestamp", 1538352000000..1540944000000)
35+
range("date_timestamp", 1538352000000..1540944000000)
3636
}
3737
}
3838
}

‎src/commonTest/kotlin/documentation/guides/results/filtering/GuideFilterNumeric.kt‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ internal class GuideFilterNumeric {
1717
val query = query("query") {
1818
filters {
1919
and {
20-
+comparison("price", Less, 100)
20+
comparison("price", Less, 100)
2121
}
2222
}
2323
}
@@ -32,7 +32,7 @@ internal class GuideFilterNumeric {
3232
val query = query("query") {
3333
filters {
3434
and {
35-
+range("price", 100..200)
35+
range("price", 100..200)
3636
}
3737
}
3838
}

‎src/commonTest/kotlin/documentation/guides/results/filtering/GuideFilterString.kt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ internal class GuideFilterString {
3333
index.search(query("smartphone") {
3434
filters {
3535
and {
36-
+facet("brand", "Motorola")
36+
facet("brand", "Motorola")
3737
}
3838
}
3939
})
@@ -42,8 +42,8 @@ internal class GuideFilterString {
4242
index.search(query("smartphone") {
4343
filters {
4444
orFacet {
45-
+facet("brand", "Motorola")
46-
+facet("brand", "Samsung")
45+
facet("brand", "Motorola")
46+
facet("brand", "Samsung")
4747
}
4848
}
4949
})
@@ -52,7 +52,7 @@ internal class GuideFilterString {
5252
index.search(query("smartphone") {
5353
filters {
5454
and {
55-
+!facet("brand", "Apple")
55+
facet("brand", "Apple", isNegated = true)
5656
}
5757
}
5858
})

‎src/commonTest/kotlin/documentation/guides/results/filtering/GuideFilterTag.kt‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ internal class GuideFilterTag {
1717
val query = query("harry") {
1818
filters {
1919
and {
20-
+tag("politics")
20+
tag("politics")
2121
}
2222
}
2323
}

‎src/commonTest/kotlin/documentation/parameters/filtering/DocFacetFilters.kt‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ internal class DocFacetFilters {
1414
// facetFilters {
1515
// // Declare an OR group for facet filters.
1616
// or {
17-
// +facet("attribute", "value")
18-
// +facet("attribute", 0)
19-
// +facet("attribute", true)
17+
// facet("attribute", "value")
18+
// facet("attribute", 0)
19+
// facet("attribute", true)
2020
//
21-
// +!facet("attribute", "value") // Negate a facet filter
21+
// facet("attribute", "value", , isNegated = true) // Negate a facet filter
2222
// }
2323
// // Declare an AND group for facet filters.
2424
// and {
25-
// +facet("attribute", "value")
26-
// +facet("attribute", true)
27-
// +facet("attribute", 0)
25+
// facet("attribute", "value")
26+
// facet("attribute", true)
27+
// facet("attribute", 0)
2828
// }
2929
// }
3030

@@ -33,7 +33,7 @@ internal class DocFacetFilters {
3333
runBlocking {
3434
val query = query("query") {
3535
facetFilters {
36-
and { +facet("category", "Book") }
36+
and { facet("category", "Book") }
3737
}
3838
}
3939

@@ -47,8 +47,8 @@ internal class DocFacetFilters {
4747
val query = query("query") {
4848
facetFilters {
4949
and {
50-
+facet("category", "Book")
51-
+facet("author", "John Doe")
50+
facet("category", "Book")
51+
facet("author", "John Doe")
5252
}
5353
}
5454
}
@@ -63,8 +63,8 @@ internal class DocFacetFilters {
6363
val query = query("query") {
6464
facetFilters {
6565
or {
66-
+facet("category", "Book")
67-
+facet("category", "Movie")
66+
facet("category", "Book")
67+
facet("category", "Movie")
6868
}
6969
}
7070
}
@@ -79,11 +79,11 @@ internal class DocFacetFilters {
7979
val query = query("query") {
8080
facetFilters {
8181
or {
82-
+facet("category", "Book")
83-
+facet("category", "Movie")
82+
facet("category", "Book")
83+
facet("category", "Movie")
8484
}
8585
and {
86-
+facet("author", "John Doe")
86+
facet("author", "John Doe")
8787
}
8888
}
8989
}

‎src/commonTest/kotlin/documentation/parameters/filtering/DocFilters.kt‎

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -16,39 +16,39 @@ internal class DocFilters {
1616
// // Declare an [OR](#boolean-operators) group for facet filters.
1717
// orFacet {
1818
// // "[attribute:value](#facet-filters)"
19-
// +facet("attribute", "value")
20-
// +facet("attribute", 0)
21-
// +facet("attribute", true)
19+
// facet("attribute", "value")
20+
// facet("attribute", 0)
21+
// facet("attribute", true)
2222
//
23-
// +!facet("attribute", "value") // Negate a filter
23+
// facet("attribute", "value", isNegated = true) // Negate a filter
2424
// }
2525
// // Declare an [OR](#boolean-operators) group for tag filters.
2626
// orTag {
2727
// // "[_tags](#tag-filters):value"
28-
// +tag("value")
28+
// tag("value")
2929
// }
3030
// // Declare an [OR](#boolean-operators) group for numeric filters.
3131
// orNumeric {
3232
// // "attribute:lowerBound [TO](#numeric-range) upperBound"
33-
// +range("attribute", 0..10)
34-
// +range("attribute", 0f, 10f)
33+
// range("attribute", 0..10)
34+
// range("attribute", 0f, 10f)
3535
// // "numeric_attribute [= | != | > | >= | < | <=](#numeric-comparisons) numeric_value"
36-
// +comparison("attribute", Less, 0f)
37-
// +comparison("attribute", LessOrEquals, 0f)
38-
// +comparison("attribute", Equals, 0f)
39-
// +comparison("attribute", NotEquals, 0f)
40-
// +comparison("attribute", Greater, 0f)
41-
// +comparison("attribute", GreaterOrEquals, 0f)
36+
// comparison("attribute", Less, 0f)
37+
// comparison("attribute", LessOrEquals, 0f)
38+
// comparison("attribute", Equals, 0f)
39+
// comparison("attribute", NotEquals, 0f)
40+
// comparison("attribute", Greater, 0f)
41+
// comparison("attribute", GreaterOrEquals, 0f)
4242
// }
4343
// // Declare an [AND](#boolean-operators) group for any type of filters.
4444
// and {
4545
// // "[attribute:value](#facet-filters)"
46-
// +facet("attribute", "value")
47-
// +facet("attribute", true)
48-
// +facet("attribute", 0)
49-
// +tag("value")
50-
// +range("attribute", 0..10)
51-
// +comparison("attribute", NumericOperator.Less, 0f)
46+
// facet("attribute", "value")
47+
// facet("attribute", true)
48+
// facet("attribute", 0)
49+
// tag("value")
50+
// range("attribute", 0..10)
51+
// comparison("attribute", NumericOperator.Less, 0f)
5252
// }
5353
// }
5454

@@ -59,11 +59,11 @@ internal class DocFilters {
5959
val query = query("query") {
6060
filters {
6161
orFacet {
62-
+facet("category", "Book")
63-
+facet("category", "Ebook")
62+
facet("category", "Book")
63+
facet("category", "Ebook")
6464
}
6565
and {
66-
+tag("published")
66+
tag("published")
6767
}
6868
}
6969
}
@@ -84,15 +84,15 @@ internal class DocFilters {
8484
val query = query("query") {
8585
filters {
8686
and {
87-
+comparison("available", Equals, 1)
88-
+tag("published")
89-
+range("publication_date", 1441745506..1441755506)
90-
+comparison("inStock", NumericOperator.Greater, 0)
91-
+facet("author", "John Doe")
87+
comparison("available", Equals, 1)
88+
tag("published")
89+
range("publication_date", 1441745506..1441755506)
90+
comparison("inStock", NumericOperator.Greater, 0)
91+
facet("author", "John Doe")
9292
}
9393
orFacet {
94-
+facet("category", "Book")
95-
+!facet("category", "EBook")
94+
facet("category", "Book")
95+
facet("category", "EBook", isNegated = true)
9696
}
9797
}
9898
}
@@ -109,7 +109,7 @@ internal class DocFilters {
109109
filters {
110110
and {
111111
// You don't have to escape strings, it is done for you.
112-
+facet("category", "Books and Comics")
112+
facet("category", "Books and Comics")
113113
}
114114
}
115115
}
@@ -126,7 +126,7 @@ internal class DocFilters {
126126
filters {
127127
and {
128128
// You don't have to escape keywords, it is done for you.
129-
+facet("keyword", "OR")
129+
facet("keyword", "OR")
130130
}
131131
}
132132
}
@@ -143,7 +143,7 @@ internal class DocFilters {
143143
filters {
144144
and {
145145
// You don't have to escape single quotes, it is done for you.
146-
+facet("content", "It's a wonderful day")
146+
facet("content", "It's a wonderful day")
147147
}
148148
}
149149
}
@@ -159,7 +159,7 @@ internal class DocFilters {
159159
val query = query("query") {
160160
filters {
161161
and {
162-
+facet("content", "She said \"Hello World\"")
162+
facet("content", "She said \"Hello World\"")
163163
}
164164
}
165165
}

‎src/commonTest/kotlin/documentation/parameters/filtering/DocNumericFilters.kt‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ internal class DocNumericFilters {
1414
// numericFilters {
1515
// and {
1616
// // "numeric_attribute [= | != | > | >= | < | <=](#numeric-comparisons) numeric_value"
17-
// +comparison("attribute", NumericOperator.Less, 0f)
18-
// +comparison("attribute", NumericOperator.LessOrEquals, 0f)
19-
// +comparison("attribute", NumericOperator.Equals, 0f)
20-
// +comparison("attribute", NotEquals, 0f)
21-
// +comparison("attribute", Greater, 0f)
22-
// +comparison("attribute", GreaterOrEquals, 0f)
17+
// comparison("attribute", NumericOperator.Less, 0f)
18+
// comparison("attribute", NumericOperator.LessOrEquals, 0f)
19+
// comparison("attribute", NumericOperator.Equals, 0f)
20+
// comparison("attribute", NotEquals, 0f)
21+
// comparison("attribute", Greater, 0f)
22+
// comparison("attribute", GreaterOrEquals, 0f)
2323
//
24-
// +!comparison("attribute", GreaterOrEquals, 0f) // Negate a numeric filter
24+
// comparison("attribute", GreaterOrEquals, 0f, isNegated = true) // Negate a numeric filter
2525
// }
2626
// or {
2727
// // "attribute:lowerBound [TO](#numeric-range) upperBound"
28-
// +range("attribute", 0..10)
29-
// +range("attribute", 0f, 10f)
28+
// range("attribute", 0..10)
29+
// range("attribute", 0f, 10f)
3030
// }
3131
// }
3232

@@ -36,11 +36,11 @@ internal class DocNumericFilters {
3636
val query = query("query") {
3737
numericFilters {
3838
or {
39-
+comparison("inStock", Equals, 0f)
40-
+comparison("deliveryDate", Less, 1441755506)
39+
comparison("inStock", Equals, 0f)
40+
comparison("deliveryDate", Less, 1441755506)
4141
}
4242
and {
43-
+comparison("price", Less, 1000)
43+
comparison("price", Less, 1000)
4444
}
4545
}
4646
}

0 commit comments

Comments
 (0)