backstage/.changeset/happy-mugs-camp.md at 43d323c917e56e8745367a903bd1059fd99045f6

Files

T

Mike Lewis c8b295f2fb search-common: introduce SearchDocument type

This type is a subset of `IndexableDocument`, and is intended to be
used in place of `IndexableDocument` in the frontend.

Signed-off-by: Mike Lewis <mtlewis@users.noreply.github.com>

2022-03-17 12:39:41 +00:00

629 B

Raw Blame History

@backstage/plugin-search-common

@backstage/plugin-search-common
patch

Introduce SearchDocument type. This type contains the subset of IndexableDocument properties relevant to the frontend, and is intended to be used for documents returned to the frontend from the search API.
SearchResultSet is now a wrapper for documents of type SearchDocument, and is intended to be used in the frontend. This isn't a breaking change, since IndexableDocuments are valid SearchDocuments, so the old and new types are compatible.
Introduce IndexableResultSet type, which wraps IndexableDocument instances in the same way as SearchResultSet.

629 B Raw Blame History

629 B

Raw Blame History