From 8330eb02e581e6a1a69784b4d4b777612c8f022b Mon Sep 17 00:00:00 2001 From: Michael Haley Date: Wed, 18 May 2022 11:55:06 -0400 Subject: [PATCH] add api-reports Signed-off-by: Michael Haley --- plugins/api-docs/api-report.md | 38 +++++++++++++++++++++++++---- plugins/catalog-react/api-report.md | 3 +++ plugins/catalog/api-report.md | 18 ++++++++++++++ 3 files changed, 54 insertions(+), 5 deletions(-) diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.md index 991c73d4ab..6246ee797e 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.md @@ -9,8 +9,11 @@ import { ApiEntity } from '@backstage/catalog-model'; import { ApiRef } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; import { CatalogTableRow } from '@backstage/plugin-catalog'; +import { ComponentEntity } from '@backstage/catalog-model'; +import { Entity } from '@backstage/catalog-model'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; import { InfoCardVariants } from '@backstage/core-components'; +import { Options } from '@material-table/core'; import { default as React_2 } from 'react'; import { RouteRef } from '@backstage/core-plugin-api'; import { TableColumn } from '@backstage/core-components'; @@ -91,13 +94,19 @@ export type AsyncApiDefinitionWidgetProps = { // Warning: (ae-missing-release-tag) "ConsumedApisCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const ConsumedApisCard: ({ variant }: Props) => JSX.Element; +export const ConsumedApisCard: ({ + variant, + tableOptions, +}: Props) => JSX.Element; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "ConsumingComponentsCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const ConsumingComponentsCard: ({ variant }: Props_4) => JSX.Element; +export const ConsumingComponentsCard: ({ + variant, + tableOptions, +}: Props_4) => JSX.Element; // @public export const DefaultApiExplorerPage: ({ @@ -128,8 +137,10 @@ export const EntityApiDefinitionCard: () => JSX.Element; // @public (undocumented) export const EntityConsumedApisCard: ({ variant, + tableOptions, }: { variant?: InfoCardVariants | undefined; + tableOptions?: Options | undefined; }) => JSX.Element; // Warning: (ae-missing-release-tag) "EntityConsumingComponentsCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -137,8 +148,10 @@ export const EntityConsumedApisCard: ({ // @public (undocumented) export const EntityConsumingComponentsCard: ({ variant, + tableOptions, }: { variant?: InfoCardVariants | undefined; + tableOptions?: Options | undefined; }) => JSX.Element; // Warning: (ae-missing-release-tag) "EntityHasApisCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -146,8 +159,10 @@ export const EntityConsumingComponentsCard: ({ // @public (undocumented) export const EntityHasApisCard: ({ variant, + tableOptions, }: { variant?: InfoCardVariants | undefined; + tableOptions?: Options | undefined; }) => JSX.Element; // Warning: (ae-missing-release-tag) "EntityProvidedApisCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -155,8 +170,10 @@ export const EntityHasApisCard: ({ // @public (undocumented) export const EntityProvidedApisCard: ({ variant, + tableOptions, }: { variant?: InfoCardVariants | undefined; + tableOptions?: Options | undefined; }) => JSX.Element; // Warning: (ae-missing-release-tag) "EntityProvidingComponentsCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -164,8 +181,10 @@ export const EntityProvidedApisCard: ({ // @public (undocumented) export const EntityProvidingComponentsCard: ({ variant, + tableOptions, }: { variant?: InfoCardVariants | undefined; + tableOptions?: Options | undefined; }) => JSX.Element; // Warning: (ae-missing-release-tag) "GraphQlDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) @@ -186,7 +205,10 @@ export type GraphQlDefinitionWidgetProps = { // Warning: (ae-missing-release-tag) "HasApisCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const HasApisCard: ({ variant }: Props_2) => JSX.Element; +export const HasApisCard: ({ + variant, + tableOptions, +}: Props_2) => JSX.Element; // Warning: (ae-missing-release-tag) "OpenApiDefinitionWidget" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // @@ -221,11 +243,17 @@ export type PlainApiDefinitionWidgetProps = { // Warning: (ae-missing-release-tag) "ProvidedApisCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const ProvidedApisCard: ({ variant }: Props_3) => JSX.Element; +export const ProvidedApisCard: ({ + variant, + tableOptions, +}: Props_3) => JSX.Element; // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts // Warning: (ae-missing-release-tag) "ProvidingComponentsCard" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal) // // @public (undocumented) -export const ProvidingComponentsCard: ({ variant }: Props_5) => JSX.Element; +export const ProvidingComponentsCard: ({ + variant, + tableOptions, +}: Props_5) => JSX.Element; ``` diff --git a/plugins/catalog-react/api-report.md b/plugins/catalog-react/api-report.md index 285ecafd70..48be22cd4a 100644 --- a/plugins/catalog-react/api-report.md +++ b/plugins/catalog-react/api-report.md @@ -26,6 +26,7 @@ import { ScmIntegrationRegistry } from '@backstage/integration'; import { StyleRules } from '@material-ui/core/styles/withStyles'; import { SystemEntity } from '@backstage/catalog-model'; import { TableColumn } from '@backstage/core-components'; +import { TableProps } from '@backstage/core-components'; // @public export const AsyncEntityProvider: ({ @@ -332,6 +333,8 @@ export interface EntityTableProps { // (undocumented) entities: T[]; // (undocumented) + tableOptions?: TableProps['options']; + // (undocumented) title: string; // (undocumented) variant?: InfoCardVariants; diff --git a/plugins/catalog/api-report.md b/plugins/catalog/api-report.md index 3d426a0c8b..70d9b05f33 100644 --- a/plugins/catalog/api-report.md +++ b/plugins/catalog/api-report.md @@ -7,6 +7,7 @@ import { ApiHolder } from '@backstage/core-plugin-api'; import { BackstagePlugin } from '@backstage/core-plugin-api'; +import { ComponentEntity } from '@backstage/catalog-model'; import { CompoundEntityRef } from '@backstage/catalog-model'; import { Entity } from '@backstage/catalog-model'; import { ExternalRouteRef } from '@backstage/core-plugin-api'; @@ -17,11 +18,13 @@ import { Observable } from '@backstage/types'; import { Overrides } from '@material-ui/core/styles/overrides'; import { default as React_2 } from 'react'; import { ReactNode } from 'react'; +import { ResourceEntity } from '@backstage/catalog-model'; import { ResultHighlight } from '@backstage/plugin-search-common'; import { RouteRef } from '@backstage/core-plugin-api'; import { StarredEntitiesApi } from '@backstage/plugin-catalog-react'; import { StorageApi } from '@backstage/core-plugin-api'; import { StyleRules } from '@material-ui/core/styles/withStyles'; +import { SystemEntity } from '@backstage/catalog-model'; import { TableColumn } from '@backstage/core-components'; import { TableProps } from '@backstage/core-components'; import { TabProps } from '@material-ui/core'; @@ -184,6 +187,8 @@ export class DefaultStarredEntitiesApi implements StarredEntitiesApi { // @public (undocumented) export interface DependencyOfComponentsCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) title?: string; // (undocumented) @@ -192,6 +197,8 @@ export interface DependencyOfComponentsCardProps { // @public (undocumented) export interface DependsOnComponentsCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) title?: string; // (undocumented) @@ -200,6 +207,8 @@ export interface DependsOnComponentsCardProps { // @public (undocumented) export interface DependsOnResourcesCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) variant?: InfoCardVariants; } @@ -348,24 +357,32 @@ export function hasCatalogProcessingErrors( // @public (undocumented) export interface HasComponentsCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) variant?: InfoCardVariants; } // @public (undocumented) export interface HasResourcesCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) variant?: InfoCardVariants; } // @public (undocumented) export interface HasSubcomponentsCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) variant?: InfoCardVariants; } // @public (undocumented) export interface HasSystemsCardProps { + // (undocumented) + tableOptions?: TableProps['options']; // (undocumented) variant?: InfoCardVariants; } @@ -406,6 +423,7 @@ export type RelatedEntitiesCardProps = { relationType: string; emptyMessage: string; emptyHelpLink: string; + tableOptions?: TableProps['options']; asRenderableEntities: (entities: Entity[]) => T[]; };