Skip to content

Commit

Permalink
catalog-backend: removed CatalogEntityDocument
Browse files Browse the repository at this point in the history
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
  • Loading branch information
Rugvip committed Mar 14, 2022
1 parent 09a711d commit ced3016
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 13 deletions.
5 changes: 5 additions & 0 deletions .changeset/silent-fishes-dream.md
Original file line number Diff line number Diff line change
@@ -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.
7 changes: 2 additions & 5 deletions plugins/catalog-backend/api-report.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
/// <reference types="node" />

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';
Expand Down Expand Up @@ -174,9 +174,6 @@ export const catalogConditions: Conditions<{
>;
}>;

// @public @deprecated (undocumented)
export type CatalogEntityDocument = CatalogEntityDocument_2;

// @public (undocumented)
export type CatalogEnvironment = {
logger: Logger;
Expand Down Expand Up @@ -355,7 +352,7 @@ export class DefaultCatalogCollator {
// (undocumented)
protected discovery: PluginEndpointDiscovery;
// (undocumented)
execute(): Promise<CatalogEntityDocument_2[]>;
execute(): Promise<CatalogEntityDocument[]>;
// (undocumented)
protected filter?: GetEntitiesRequest['filter'];
// (undocumented)
Expand Down
8 changes: 0 additions & 8 deletions plugins/catalog-backend/src/search/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*/
Expand Down

0 comments on commit ced3016

Please sign in to comment.