From 9e662b85b1d96b99effd88e8c24a07ce9a53bbbb Mon Sep 17 00:00:00 2001 From: Christopher Hawke <69921547+cdhawke@users.noreply.github.com> Date: Mon, 18 Jul 2022 09:40:04 -0400 Subject: [PATCH 1/2] feat(client-search): Updating searchoptions type to include explain attribute --- packages/client-search/src/types/SearchOptions.ts | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/packages/client-search/src/types/SearchOptions.ts b/packages/client-search/src/types/SearchOptions.ts index e2f47a26f..7434e5d32 100644 --- a/packages/client-search/src/types/SearchOptions.ts +++ b/packages/client-search/src/types/SearchOptions.ts @@ -373,4 +373,11 @@ export type SearchOptions = { * Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection. */ readonly queryLanguages?: readonly string[]; + + /** + * Enriches the API’s response with meta-information as to how the query was processed. This attirbute powers the 'Query Alternatives' explanation. + * There is currently no official documentation on the API for this attribute. + * @link RFC: https://docs.google.com/document/d/1Z58mZks5EiF1z0tbswLpKMSw-rRngRpESdBqGoAAzDo + */ + readonly explain?: readonly string[]; }; From c0a9119d338cf6d39f63b7d014c7b135e6137b7a Mon Sep 17 00:00:00 2001 From: Christopher Hawke <69921547+cdhawke@users.noreply.github.com> Date: Mon, 18 Jul 2022 10:08:15 -0400 Subject: [PATCH 2/2] feat(client-search): pr feedback --- packages/client-search/src/types/SearchOptions.ts | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/packages/client-search/src/types/SearchOptions.ts b/packages/client-search/src/types/SearchOptions.ts index 7434e5d32..3f9c690af 100644 --- a/packages/client-search/src/types/SearchOptions.ts +++ b/packages/client-search/src/types/SearchOptions.ts @@ -375,9 +375,7 @@ export type SearchOptions = { readonly queryLanguages?: readonly string[]; /** - * Enriches the API’s response with meta-information as to how the query was processed. This attirbute powers the 'Query Alternatives' explanation. - * There is currently no official documentation on the API for this attribute. - * @link RFC: https://docs.google.com/document/d/1Z58mZks5EiF1z0tbswLpKMSw-rRngRpESdBqGoAAzDo + * Enriches the API’s response with meta-information as to how the query was processed. */ readonly explain?: readonly string[]; };