From 928c9ba27bf24fa852821e166d0c9434b08cb308 Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Tue, 17 Aug 2021 09:28:36 +0200 Subject: [PATCH] API reports Signed-off-by: Johan Haals --- packages/catalog-client/api-report.md | 53 ++++++++++++--------------- 1 file changed, 24 insertions(+), 29 deletions(-) diff --git a/packages/catalog-client/api-report.md b/packages/catalog-client/api-report.md index 2e39dfd07f..173af9aef3 100644 --- a/packages/catalog-client/api-report.md +++ b/packages/catalog-client/api-report.md @@ -25,6 +25,11 @@ export type AddLocationResponse = { entities: Entity[]; }; +// Warning: (ae-missing-release-tag) "CATALOG_FILTER_EXISTS" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// +// @public (undocumented) +export const CATALOG_FILTER_EXISTS: unique symbol; + // Warning: (ae-missing-release-tag) "CatalogApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) @@ -71,59 +76,50 @@ export interface CatalogApi { ): Promise; } -// Warning: (ae-forgotten-export) The symbol "CatalogApi" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "CatalogClient" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export class CatalogClient implements CatalogApi_2 { - constructor(options: { discoveryApi: DiscoveryApi_2 }); - // Warning: (ae-forgotten-export) The symbol "AddLocationRequest" needs to be exported by the entry point index.d.ts - // Warning: (ae-forgotten-export) The symbol "AddLocationResponse" needs to be exported by the entry point index.d.ts - // +export class CatalogClient implements CatalogApi { + constructor(options: { discoveryApi: DiscoveryApi }); // (undocumented) addLocation( - { type, target, dryRun, presence }: AddLocationRequest_2, - options?: CatalogRequestOptions_2, - ): Promise; - // Warning: (ae-forgotten-export) The symbol "CatalogEntitiesRequest" needs to be exported by the entry point index.d.ts - // Warning: (ae-forgotten-export) The symbol "CatalogListResponse" needs to be exported by the entry point index.d.ts - // + { type, target, dryRun, presence }: AddLocationRequest, + options?: CatalogRequestOptions, + ): Promise; // (undocumented) getEntities( - request?: CatalogEntitiesRequest_2, - options?: CatalogRequestOptions_2, - ): Promise>; + request?: CatalogEntitiesRequest, + options?: CatalogRequestOptions, + ): Promise>; // (undocumented) getEntityByName( compoundName: EntityName, - options?: CatalogRequestOptions_2, + options?: CatalogRequestOptions, ): Promise; // (undocumented) getLocationByEntity( entity: Entity, - options?: CatalogRequestOptions_2, + options?: CatalogRequestOptions, ): Promise; - // Warning: (ae-forgotten-export) The symbol "CatalogRequestOptions" needs to be exported by the entry point index.d.ts - // // (undocumented) getLocationById( id: string, - options?: CatalogRequestOptions_2, + options?: CatalogRequestOptions, ): Promise; // (undocumented) getOriginLocationByEntity( entity: Entity, - options?: CatalogRequestOptions_2, + options?: CatalogRequestOptions, ): Promise; // (undocumented) removeEntityByUid( uid: string, - options?: CatalogRequestOptions_2, + options?: CatalogRequestOptions, ): Promise; // (undocumented) removeLocationById( id: string, - options?: CatalogRequestOptions_2, + options?: CatalogRequestOptions, ): Promise; } @@ -132,8 +128,8 @@ export class CatalogClient implements CatalogApi_2 { // @public (undocumented) export type CatalogEntitiesRequest = { filter?: - | Record[] - | Record + | Record[] + | Record | undefined; fields?: string[] | undefined; }; @@ -152,12 +148,11 @@ export type CatalogRequestOptions = { token?: string; }; -// Warning: (ae-missing-release-tag) "DiscoveryApi" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) +// Warning: (ae-missing-release-tag) "ENTITY_STATUS_CATALOG_PROCESSING_TYPE" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public -export type DiscoveryApi = { - getBaseUrl(pluginId: string): Promise; -}; +export const ENTITY_STATUS_CATALOG_PROCESSING_TYPE = + 'backstage.io/catalog-processing'; // Warnings were encountered during analysis: //