From b75a2d984c35525dc8930fa8e57e2071bec7c6f1 Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Thu, 1 Feb 2024 19:25:16 +0100 Subject: [PATCH] docs: update api reports Signed-off-by: Camila Belo --- plugins/catalog-graph/api-report-alpha.md | 29 +++++++++++++++++++++++ plugins/catalog-react/api-report-alpha.md | 10 +++++--- 2 files changed, 36 insertions(+), 3 deletions(-) create mode 100644 plugins/catalog-graph/api-report-alpha.md diff --git a/plugins/catalog-graph/api-report-alpha.md b/plugins/catalog-graph/api-report-alpha.md new file mode 100644 index 0000000000..3895f12fcf --- /dev/null +++ b/plugins/catalog-graph/api-report-alpha.md @@ -0,0 +1,29 @@ +## API Report File for "@backstage/plugin-catalog-graph" + +> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). + +```ts +import { BackstagePlugin } from '@backstage/frontend-plugin-api'; +import { ExternalRouteRef } from '@backstage/frontend-plugin-api'; +import { RouteRef } from '@backstage/frontend-plugin-api'; + +// @public (undocumented) +const _default: BackstagePlugin< + { + catalogGraph: RouteRef; + }, + { + catalogEntity: ExternalRouteRef< + { + name: string; + kind: string; + namespace: string; + }, + true + >; + } +>; +export default _default; + +// (No @packageDocumentation comment for this package) +``` diff --git a/plugins/catalog-react/api-report-alpha.md b/plugins/catalog-react/api-report-alpha.md index cf9fdc6c3a..fb807d947d 100644 --- a/plugins/catalog-react/api-report-alpha.md +++ b/plugins/catalog-react/api-report-alpha.md @@ -9,6 +9,7 @@ import { AnyExtensionInputMap } from '@backstage/frontend-plugin-api'; import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api'; import { Entity } from '@backstage/catalog-model'; import { ExtensionDefinition } from '@backstage/frontend-plugin-api'; +import { PortableSchema } from '@backstage/frontend-plugin-api'; import { ResolvedExtensionInputs } from '@backstage/frontend-plugin-api'; import { ResourcePermission } from '@backstage/plugin-permission-common'; import { RouteRef } from '@backstage/frontend-plugin-api'; @@ -25,6 +26,9 @@ export const catalogExtensionData: { // @alpha (undocumented) export function createEntityCardExtension< + TConfig extends { + filter?: string; + }, TInputs extends AnyExtensionInputMap, >(options: { namespace?: string; @@ -35,15 +39,15 @@ export function createEntityCardExtension< }; disabled?: boolean; inputs?: TInputs; + configSchema?: PortableSchema; filter?: | typeof catalogExtensionData.entityFilterFunction.T | typeof catalogExtensionData.entityFilterExpression.T; loader: (options: { + config: TConfig; inputs: Expand>; }) => Promise; -}): ExtensionDefinition<{ - filter?: string | undefined; -}>; +}): ExtensionDefinition; // @alpha (undocumented) export function createEntityContentExtension<