From ced3016f2aa7937852b89f1dbc35d441ca8b09bb Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Mon, 14 Mar 2022 10:44:28 +0100 Subject: [PATCH] catalog-backend: removed CatalogEntityDocument Signed-off-by: Patrik Oldsberg --- .changeset/silent-fishes-dream.md | 5 +++++ plugins/catalog-backend/api-report.md | 7 ++----- plugins/catalog-backend/src/search/index.ts | 8 -------- 3 files changed, 7 insertions(+), 13 deletions(-) create mode 100644 .changeset/silent-fishes-dream.md diff --git a/.changeset/silent-fishes-dream.md b/.changeset/silent-fishes-dream.md new file mode 100644 index 0000000000..ea4b8c33c0 --- /dev/null +++ b/.changeset/silent-fishes-dream.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-catalog-backend': minor +--- + +**BREAKING**: The deprecated `CatalogEntityDocument` export has been removed, it can be imported from `@backstage/plugin-catalog-common` instead. diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index 714fdffb87..31ee5af1f2 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -6,7 +6,7 @@ /// import { CatalogApi } from '@backstage/catalog-client'; -import { CatalogEntityDocument as CatalogEntityDocument_2 } from '@backstage/plugin-catalog-common'; +import { CatalogEntityDocument } from '@backstage/plugin-catalog-common'; import { CompoundEntityRef } from '@backstage/catalog-model'; import { ConditionalPolicyDecision } from '@backstage/plugin-permission-node'; import { Conditions } from '@backstage/plugin-permission-node'; @@ -174,9 +174,6 @@ export const catalogConditions: Conditions<{ >; }>; -// @public @deprecated (undocumented) -export type CatalogEntityDocument = CatalogEntityDocument_2; - // @public (undocumented) export type CatalogEnvironment = { logger: Logger; @@ -355,7 +352,7 @@ export class DefaultCatalogCollator { // (undocumented) protected discovery: PluginEndpointDiscovery; // (undocumented) - execute(): Promise; + execute(): Promise; // (undocumented) protected filter?: GetEntitiesRequest['filter']; // (undocumented) diff --git a/plugins/catalog-backend/src/search/index.ts b/plugins/catalog-backend/src/search/index.ts index eb5b1e7c22..2602f0fada 100644 --- a/plugins/catalog-backend/src/search/index.ts +++ b/plugins/catalog-backend/src/search/index.ts @@ -17,14 +17,6 @@ export { DefaultCatalogCollatorFactory } from './DefaultCatalogCollatorFactory'; export type { DefaultCatalogCollatorFactoryOptions } from './DefaultCatalogCollatorFactory'; -import { CatalogEntityDocument as CatalogEntityDocumentType } from '@backstage/plugin-catalog-common'; - -/** - * @deprecated import from `@backstage/plugin-catalog-common` instead - * @public - */ -export type CatalogEntityDocument = CatalogEntityDocumentType; - /** * todo(backstage/techdocs-core): stop exporting this in a future release. */