Update API doc

Signed-off-by: Damien Vitrac <dvitrac@vmware.com>
This commit is contained in:
Damien Vitrac
2022-04-25 10:14:44 +02:00
parent 4274844a8c
commit 10f00809cb
3 changed files with 17 additions and 15 deletions
+6 -5
View File
@@ -10,6 +10,7 @@ import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogTableRow } from '@backstage/plugin-catalog';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { InfoCardVariants } from '@backstage/core-components';
import { default as React_2 } from 'react';
import { RouteRef } from '@backstage/core-plugin-api';
import { TableColumn } from '@backstage/core-components';
@@ -128,7 +129,7 @@ export const EntityApiDefinitionCard: () => JSX.Element;
export const EntityConsumedApisCard: ({
variant,
}: {
variant?: 'gridItem' | undefined;
variant?: InfoCardVariants | 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,7 +138,7 @@ export const EntityConsumedApisCard: ({
export const EntityConsumingComponentsCard: ({
variant,
}: {
variant?: 'gridItem' | undefined;
variant?: InfoCardVariants | 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,7 +147,7 @@ export const EntityConsumingComponentsCard: ({
export const EntityHasApisCard: ({
variant,
}: {
variant?: 'gridItem' | undefined;
variant?: InfoCardVariants | 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,7 +156,7 @@ export const EntityHasApisCard: ({
export const EntityProvidedApisCard: ({
variant,
}: {
variant?: 'gridItem' | undefined;
variant?: InfoCardVariants | 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,7 +165,7 @@ export const EntityProvidedApisCard: ({
export const EntityProvidingComponentsCard: ({
variant,
}: {
variant?: 'gridItem' | undefined;
variant?: InfoCardVariants | 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)
+2 -1
View File
@@ -13,6 +13,7 @@ import { ComponentProps } from 'react';
import { CompoundEntityRef } from '@backstage/catalog-model';
import { Entity } from '@backstage/catalog-model';
import { IconButton } from '@material-ui/core';
import { InfoCardVariants } from '@backstage/core-components';
import { LinkProps } from '@backstage/core-components';
import { Observable } from '@backstage/types';
import { Overrides } from '@material-ui/core/styles/overrides';
@@ -333,7 +334,7 @@ export interface EntityTableProps<T extends Entity> {
// (undocumented)
title: string;
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public
+9 -9
View File
@@ -184,7 +184,7 @@ export interface DependencyOfComponentsCardProps {
// (undocumented)
title?: string;
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
@@ -192,13 +192,13 @@ export interface DependsOnComponentsCardProps {
// (undocumented)
title?: string;
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
export interface DependsOnResourcesCardProps {
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
@@ -283,7 +283,7 @@ export interface EntityLinksCardProps {
// (undocumented)
cols?: ColumnBreakpoints | number;
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
@@ -344,25 +344,25 @@ export function hasCatalogProcessingErrors(
// @public (undocumented)
export interface HasComponentsCardProps {
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
export interface HasResourcesCardProps {
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
export interface HasSubcomponentsCardProps {
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public (undocumented)
export interface HasSystemsCardProps {
// (undocumented)
variant?: 'gridItem';
variant?: InfoCardVariants;
}
// @public
@@ -390,7 +390,7 @@ export const RelatedEntitiesCard: <T extends Entity>(
// @public (undocumented)
export type RelatedEntitiesCardProps<T extends Entity> = {
variant?: 'gridItem';
variant?: InfoCardVariants;
title: string;
columns: TableColumn<T>[];
entityKind?: string;