From 21f87ec5bc7e1fbdefc219596f6da9152982f1ac Mon Sep 17 00:00:00 2001 From: Roy Jacobs Date: Tue, 31 Aug 2021 13:56:05 +0200 Subject: [PATCH] Update api-report.md Signed-off-by: Roy Jacobs --- plugins/catalog-backend/api-report.md | 28 ++++++++------------------- 1 file changed, 8 insertions(+), 20 deletions(-) diff --git a/plugins/catalog-backend/api-report.md b/plugins/catalog-backend/api-report.md index b46f860207..f6e864221c 100644 --- a/plugins/catalog-backend/api-report.md +++ b/plugins/catalog-backend/api-report.md @@ -7,6 +7,7 @@ import { Account } from 'aws-sdk/clients/organizations'; import { BitbucketIntegration } from '@backstage/integration'; +import { CatalogEntitiesRequest } from '@backstage/catalog-client'; import { Config } from '@backstage/config'; import { DocumentCollator } from '@backstage/search-common'; import { Entity } from '@backstage/catalog-model'; @@ -204,22 +205,6 @@ export class CatalogBuilder { ): CatalogBuilder; } -// Warning: (ae-missing-release-tag) "CatalogEntityDocument" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) -export interface CatalogEntityDocument extends IndexableDocument { - // (undocumented) - componentType: string; - // (undocumented) - kind: string; - // (undocumented) - lifecycle: string; - // (undocumented) - namespace: string; - // (undocumented) - owner: string; -} - // Warning: (ae-missing-release-tag) "CatalogProcessingOrchestrator" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -581,11 +566,11 @@ export class DefaultCatalogCollator implements DocumentCollator { constructor({ discovery, locationTemplate, - allow, + filter, }: { discovery: PluginEndpointDiscovery; locationTemplate?: string; - allow?: string[]; + filter?: CatalogEntitiesRequest['filter']; }); // (undocumented) protected applyArgsToFormat( @@ -594,15 +579,18 @@ export class DefaultCatalogCollator implements DocumentCollator { ): string; // (undocumented) protected discovery: PluginEndpointDiscovery; + // Warning: (ae-forgotten-export) The symbol "CatalogEntityDocument" needs to be exported by the entry point index.d.ts + // // (undocumented) execute(): Promise; // (undocumented) - protected filterUrl: string; + protected filterUrl?: string; // (undocumented) static fromConfig( - config: Config, + _config: Config, options: { discovery: PluginEndpointDiscovery; + filter?: CatalogEntitiesRequest['filter']; }, ): DefaultCatalogCollator; // (undocumented)