-
Notifications
You must be signed in to change notification settings - Fork 13
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix(specs): highlight result map definition (#2312)
- Loading branch information
Showing
14 changed files
with
114 additions
and
94 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
0.0.103 | ||
0.0.104 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
highlightResultOption: | ||
type: object | ||
description: Show highlighted section and words matched on a query. | ||
additionalProperties: false | ||
x-discriminator-fields: | ||
- matchLevel | ||
- value | ||
- matchedWords | ||
properties: | ||
value: | ||
$ref: '#/highlightedValue' | ||
matchLevel: | ||
$ref: '#/matchLevel' | ||
matchedWords: | ||
type: array | ||
description: List of words from the query that matched the object. | ||
example: ['action'] | ||
items: | ||
type: string | ||
fullyHighlighted: | ||
type: boolean | ||
description: Whether the entire attribute value is highlighted. | ||
required: | ||
- value | ||
- matchLevel | ||
- matchedWords | ||
|
||
highlightedValue: | ||
type: string | ||
description: Markup text with `facetQuery` matches highlighted. | ||
example: '<em>George</em> <em>Clo</em>oney' | ||
|
||
matchLevel: | ||
type: string | ||
description: Indicates how well the attribute matched the search query. | ||
enum: [none, partial, full] | ||
|
||
highlightResultOptionMap: | ||
type: object | ||
description: Show highlighted section and words matched on a query. | ||
additionalProperties: | ||
$ref: '#/highlightResultOption' | ||
|
||
highlightResult: | ||
oneOf: | ||
- $ref: '#/highlightResultOption' | ||
- $ref: '#/highlightResultOptionMap' | ||
|
||
highlightResultMap: | ||
type: object | ||
description: Show highlighted section and words matched on a query. | ||
additionalProperties: | ||
$ref: '#/highlightResult' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
snippetResultOption: | ||
type: object | ||
description: Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty. | ||
additionalProperties: false | ||
properties: | ||
value: | ||
$ref: './HighlightResult.yml#/highlightedValue' | ||
matchLevel: | ||
$ref: './HighlightResult.yml#/matchLevel' | ||
required: | ||
- value | ||
- matchLevel | ||
|
||
snippetResultOptionMap: | ||
type: object | ||
description: Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty. | ||
additionalProperties: | ||
$ref: '#/snippetResultOption' | ||
|
||
snippetResult: | ||
oneOf: | ||
- $ref: '#/snippetResultOption' | ||
- $ref: '#/snippetResultOptionMap' | ||
|
||
snippetResultMap: | ||
type: object | ||
description: Snippeted attributes show parts of the matched attributes. Only returned when attributesToSnippet is non-empty. | ||
additionalProperties: | ||
$ref: '#/snippetResult' |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters