Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add matchedSubstrings to spellCheck interface #192

Merged
merged 5 commits into from
Jul 26, 2022

Conversation

alextaing
Copy link
Contributor

@alextaing alextaing commented Jul 25, 2022

Raiden needs access to matchedSubstrings from the spellCheck part of the Search API response. Since changing correctedQuery from a string to an object would be a breaking change, we added a new property to the spellCheck interface that holds the matchedSubstrings. matchedSubstrings was also added to the Core response when the spellCheck object is created in createSpellCheck.

J=SLAP-2274
TEST=manual

It was verified that when spellCheck was provided in the Core response, that matchedSubstrings was also provided as its own property.

@alextaing alextaing requested a review from a team as a code owner July 25, 2022 20:20
@coveralls
Copy link

coveralls commented Jul 25, 2022

Pull Request Test Coverage Report for Build 2739777204

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • No unchanged relevant lines lost coverage.
  • Overall coverage remained the same at 89.826%

Totals Coverage Status
Change from base Build 2691813093: 0.0%
Covered Lines: 210
Relevant Lines: 227

💛 - Coveralls

package.json Outdated Show resolved Hide resolved
Copy link
Contributor

@yen-tt yen-tt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to confirm, you want to publish a beta version right? This should point to develop instead of master

@alextaing alextaing changed the base branch from master to develop July 26, 2022 13:21
@alextaing alextaing merged commit 40504f4 into develop Jul 26, 2022
@alextaing alextaing deleted the dev/matched-substrings-spell-check branch July 26, 2022 15:46
@alextaing alextaing restored the dev/matched-substrings-spell-check branch July 26, 2022 15:52
@alextaing alextaing mentioned this pull request Jul 26, 2022
alextaing added a commit that referenced this pull request Jul 27, 2022
## Version 1.9.0
### Changes
- `Result` now accepts a generic type parameter: a TS model representing one or more entity types generated by the new `yext types generate search` CLI command (#188)
- `matchedSubstrings` is now returned as a part of `spellCheck` in search responses (#192)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants