Skip to content

Commit a398703

Browse files
committed
Updated API from documentation release
1 parent 58e0771 commit a398703

File tree

3 files changed

+39
-0
lines changed

3 files changed

+39
-0
lines changed
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
#%RAML 1.0 DataType
2+
(package): Search
3+
(beta): true
4+
type: SearchQueryExpression
5+
displayName: SearchFuzzyExpression
6+
properties:
7+
fuzzy:
8+
type: SearchFuzzyValue
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
#%RAML 1.0 DataType
2+
(package): Search
3+
(beta): true
4+
type: SearchQueryExpressionValue
5+
displayName: SearchFuzzyValue
6+
properties:
7+
value:
8+
type: any
9+
description: |
10+
The search term to find fuzzy matches for. If multiple terms are provided (separated by whitespace), the fuzziness level is applied to each term individually.
11+
level:
12+
type: number
13+
format: int8
14+
minimum: 0
15+
maximum: 2
16+
description: |
17+
The maximum fuzziness level desired for the search term. Allowed values are `0`, `1`, and `2`. The API automatically adjusts the effective fuzziness level based on the length of the search term if it exceeds the maximum allowed for the given string length according to the following rules:
18+
19+
* Terms with 1-2 characters: 0 (exact match)
20+
* Terms with 3-5 characters: 1 (up to one difference is allowed)
21+
* Terms with more than 5 characters: 2 (up to two differences are allowed)
22+
language?:
23+
type: Locale
24+
description: |
25+
Language of the localized value. Must be provided when the field is of type `localizedTextField`. The provided Locale must be one of the Project's languages.
26+
mustMatch?:
27+
type: SearchMatchType
28+
description: |
29+
Controls whether all of the provided terms must match (`all`, default) or any of those (`any`).

api-specs/api/types/types.raml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2319,6 +2319,8 @@ SearchFullTextExpression: !include search/SearchFullTextExpression.raml
23192319
SearchFullTextPrefixExpression: !include search/SearchFullTextPrefixExpression.raml
23202320
SearchFullTextPrefixValue: !include search/SearchFullTextPrefixValue.raml
23212321
SearchFullTextValue: !include search/SearchFullTextValue.raml
2322+
SearchFuzzyExpression: !include search/SearchFuzzyExpression.raml
2323+
SearchFuzzyValue: !include search/SearchFuzzyValue.raml
23222324
SearchLongRangeExpression: !include search/SearchLongRangeExpression.raml
23232325
SearchLongRangeValue: !include search/SearchLongRangeValue.raml
23242326
SearchMatchType: !include search/SearchMatchType.raml

0 commit comments

Comments
 (0)