fix(specs): correct type for highlightResult and snippetResult #783
Conversation
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
millotp
requested review from
damcou and
shortcuts
and removed request for
a team
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
millotp
force-pushed
the
fix/highligh-result
branch
from
84f1a5d
to
c64f250
Compare
shortcuts
reviewed
Jul 4, 2022
specs/search/common/schemas/Hit.yml
Outdated
|
|
||
| highlightResultMap: | ||
| type: object | ||
| description: Highlighted attributes. |
There was a problem hiding this comment.
The description is not ideal but we can add a similar one to the snippetResultMap too
There was a problem hiding this comment.
Suggested change
| description: Highlighted attributes. | |
| description: Highlighted section and words matched by a query. |
|
wait it's more complicated than I thought, it should be a oneOf 😭 |
For when it's matched you mean? |
|
the real type is: type Inner = {
value: string;
matchLevel: (enum);
matchedWords: string[];
fullyHighlighted?: boolean
}
type HighlighResult = Record<String, Inner | Inner[]>;which is completely different from the doc of course |
Ah.... good news is, it should not be a big deal on our side :D |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
🎟 JIRA Ticket: APIC-565
Use correct types.