paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 36 Packages Projects Releases Wiki Activity

update api reports

Browse Source 
Signed-off-by: Paul Schultz <pschultz@pobox.com>

fix linting

Signed-off-by: Paul Schultz <pschultz@pobox.com>
This commit is contained in:
Paul Schultz
2025-01-28 10:31:34 -06:00
parent 2e26579e06
commit 66d2113abe
63 changed files with 762 additions and 969 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/api-docs/report-alpha.api.md
+22 -58
View File
@@ -16,7 +16,7 @@ import { ExtensionInput } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/frontend-plugin-api';
import { FrontendPlugin } from '@backstage/frontend-plugin-api';
import { IconComponent } from '@backstage/core-plugin-api';
import { default as React_2 } from 'react';
import { JSX as JSX_2 } from 'react';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @public (undocumented)
@@ -48,18 +48,14 @@ const _default: FrontendPlugin<
name: 'consumed-apis';
config: {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
type: 'info' | 'summary' | 'content' | undefined;
};
configInput: {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
type?: 'info' | 'summary' | 'content' | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
@@ -93,18 +89,14 @@ const _default: FrontendPlugin<
name: 'consuming-components';
config: {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
type: 'info' | 'summary' | 'content' | undefined;
};
configInput: {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
type?: 'info' | 'summary' | 'content' | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
@@ -138,18 +130,14 @@ const _default: FrontendPlugin<
name: 'definition';
config: {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
type: 'info' | 'summary' | 'content' | undefined;
};
configInput: {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
type?: 'info' | 'summary' | 'content' | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
@@ -183,18 +171,14 @@ const _default: FrontendPlugin<
name: 'has-apis';
config: {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
type: 'info' | 'summary' | 'content' | undefined;
};
configInput: {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
type?: 'info' | 'summary' | 'content' | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
@@ -228,18 +212,14 @@ const _default: FrontendPlugin<
name: 'provided-apis';
config: {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
type: 'info' | 'summary' | 'content' | undefined;
};
configInput: {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
type?: 'info' | 'summary' | 'content' | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
@@ -273,18 +253,14 @@ const _default: FrontendPlugin<
name: 'providing-components';
config: {
filter: EntityPredicate | undefined;
type: 'content' | 'summary' | 'info' | undefined;
type: 'info' | 'summary' | 'content' | undefined;
};
configInput: {
filter?: EntityPredicate | undefined;
type?: 'content' | 'summary' | 'info' | undefined;
type?: 'info' | 'summary' | 'content' | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<
(entity: Entity) => boolean,
'catalog.entity-filter-function',
@@ -329,11 +305,7 @@ const _default: FrontendPlugin<
group?: string | false | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
@@ -394,11 +366,7 @@ const _default: FrontendPlugin<
group?: string | false | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
@@ -476,11 +444,7 @@ const _default: FrontendPlugin<
path?: string | undefined;
};
output:
| ConfigurableExtensionDataRef<
React_2.JSX.Element,
'core.reactElement',
{}
>
| ConfigurableExtensionDataRef<JSX_2.Element, 'core.reactElement', {}>
| ConfigurableExtensionDataRef<string, 'core.routing.path', {}>
| ConfigurableExtensionDataRef<
RouteRef<AnyRouteRefParams>,
plugins/api-docs/report.api.md
+18 -20
View File
@@ -12,8 +12,8 @@ import { EntityListPagination } from '@backstage/plugin-catalog-react';
import { EntityOwnerPickerProps } from '@backstage/plugin-catalog-react';
import { ExternalRouteRef } from '@backstage/core-plugin-api';
import { InfoCardVariants } from '@backstage/core-components';
import { JSX as JSX_2 } from 'react';
import { default as React_2 } from 'react';
import { JSX as JSX_2 } from 'react/jsx-runtime';
import { ReactElement } from 'react';
import { RouteRef } from '@backstage/core-plugin-api';
import { TableColumn } from '@backstage/core-components';
import { TableOptions } from '@backstage/core-components';
@@ -21,20 +21,20 @@ import { TableProps } from '@backstage/core-components';
import { UserListFilterKind } from '@backstage/plugin-catalog-react';
// @public (undocumented)
export const ApiDefinitionCard: () => React_2.JSX.Element;
export const ApiDefinitionCard: () => JSX_2.Element;
// @public
export function ApiDefinitionDialog(props: {
open: boolean;
entity: ApiEntity;
onClose: () => void;
}): React_2.JSX.Element;
}): JSX_2.Element;
// @public (undocumented)
export type ApiDefinitionWidget = {
type: string;
title: string;
component: (definition: string) => React_2.ReactElement;
component: (definition: string) => ReactElement;
rawLanguage?: string;
};
@@ -64,7 +64,7 @@ export { apiDocsPlugin as plugin };
// @public
export const ApiExplorerIndexPage: (
props: DefaultApiExplorerPageProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public (undocumented)
export const ApiExplorerPage: (
@@ -72,14 +72,12 @@ export const ApiExplorerPage: (
) => JSX_2.Element;
// @public (undocumented)
export const ApiTypeTitle: (props: {
apiEntity: ApiEntity;
}) => React_2.JSX.Element;
export const ApiTypeTitle: (props: { apiEntity: ApiEntity }) => JSX_2.Element;
// @public (undocumented)
export const AsyncApiDefinitionWidget: (
props: AsyncApiDefinitionWidgetProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public (undocumented)
export type AsyncApiDefinitionWidgetProps = {
@@ -101,18 +99,18 @@ export const ConsumedApisCard: (props: {
title?: string;
columns?: TableColumn<ApiEntity>[];
tableOptions?: TableOptions;
}) => React_2.JSX.Element;
}) => JSX_2.Element;
// @public (undocumented)
export const ConsumingComponentsCard: (props: {
variant?: InfoCardVariants;
columns?: TableColumn<ComponentEntity>[];
}) => React_2.JSX.Element;
}) => JSX_2.Element;
// @public
export const DefaultApiExplorerPage: (
props: DefaultApiExplorerPageProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public
export type DefaultApiExplorerPageProps = {
@@ -168,7 +166,7 @@ export const EntityProvidingComponentsCard: (props: {
// @public (undocumented)
export const GraphQlDefinitionWidget: (
props: GraphQlDefinitionWidgetProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public (undocumented)
export type GraphQlDefinitionWidgetProps = {
@@ -181,12 +179,12 @@ export const HasApisCard: (props: {
title?: string;
columns?: TableColumn<ApiEntity>[];
tableOptions?: TableOptions;
}) => React_2.JSX.Element;
}) => JSX_2.Element;
// @public (undocumented)
export const OpenApiDefinitionWidget: (
props: OpenApiDefinitionWidgetProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public (undocumented)
export type OpenApiDefinitionWidgetProps = {
@@ -198,7 +196,7 @@ export type OpenApiDefinitionWidgetProps = {
// @public (undocumented)
export const PlainApiDefinitionWidget: (
props: PlainApiDefinitionWidgetProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public (undocumented)
export type PlainApiDefinitionWidgetProps = {
@@ -212,18 +210,18 @@ export const ProvidedApisCard: (props: {
title?: string;
columns?: TableColumn<ApiEntity>[];
tableOptions?: TableOptions;
}) => React_2.JSX.Element;
}) => JSX_2.Element;
// @public (undocumented)
export const ProvidingComponentsCard: (props: {
variant?: InfoCardVariants;
columns?: TableColumn<ComponentEntity>[];
}) => React_2.JSX.Element;
}) => JSX_2.Element;
// @public (undocumented)
export const TrpcApiDefinitionWidget: (
props: TrpcApiDefinitionWidgetProps,
) => React_2.JSX.Element;
) => JSX_2.Element;
// @public (undocumented)
export type TrpcApiDefinitionWidgetProps = {