From d48122a4390080c67f4045a46e7046ccfe77e97d Mon Sep 17 00:00:00 2001 From: MT Lewis Date: Thu, 17 Mar 2022 16:00:26 +0000 Subject: [PATCH] search: discourage use of IndexableDocument in the frontend Signed-off-by: MT Lewis --- plugins/search-common/src/types.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/plugins/search-common/src/types.ts b/plugins/search-common/src/types.ts index 21aed101f6..4eedabeb71 100644 --- a/plugins/search-common/src/types.ts +++ b/plugins/search-common/src/types.ts @@ -88,7 +88,10 @@ export interface SearchDocument { } /** - * Properties related to indexing of documents. + * Properties related to indexing of documents. This type is only useful for + * backends working directly with documents being inserted or retrieved from + * search indexes. When dealing with documents in the frontend, use + * {@link SearchDocument}. * @beta */ export type IndexableDocument = SearchDocument & {