paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 43 Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2022-03-03 13:37:33 +01:00
committed by GitHub
parent 50b09a5fff
commit 2255bfd1c4
2 changed files with 6 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/small-hornets-dress.md
+5 -1
View File
@@ -3,4 +3,8 @@
'@backstage/plugin-catalog-common': patch
---
Moved the `CatalogEntityDocument` to `@backstage/plugin-catalog-common` and deprecated the export from `@backstage/plugin-catalog-backend`
Moved the `CatalogEntityDocument` to `@backstage/plugin-catalog-common` and deprecated the export from `@backstage/plugin-catalog-backend`.
A new `type` field has also been added to `CatalogEntityDocument` as a replacement for `componentType`, which is now deprecated. Both fields are still present and should be set to the same value in order to avoid issues with indexing.
Any search customizations need to be updated to use this new `type` field instead, including any custom frontend filters, custom frontend result components, custom search decorators, or non-default Catalog collator implementations.
plugins/catalog-common/src/search/CatalogEntityDocument.ts
+1 -1
View File
@@ -21,7 +21,7 @@ import { IndexableDocument } from '@backstage/search-common';
* @public
*/
export interface CatalogEntityDocument extends IndexableDocument {
/** @deprecated use `type` as well, as `componentType` will be removed after a few releases but we dont want to break indexing */
/** @deprecated `componentType` is being renamed to `type`. During the transition both of these fields should be set to the same value, in order to avoid issues with indexing. */
componentType: string;
type: string;
namespace: string;