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

API report updates for extension ID redesign

Browse Source 
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2023-11-22 19:12:53 +01:00
parent e56eb22c54
commit a794f37a14
12 changed files with 108 additions and 60 deletions
Download Patch File Download Diff File Expand all files Collapse all files
plugins/adr/api-report-alpha.md
+2 -2
View File
@@ -4,11 +4,11 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { TranslationRef } from '@backstage/core-plugin-api/alpha';
// @alpha (undocumented)
export const AdrSearchResultListItemExtension: Extension<{
export const AdrSearchResultListItemExtension: ExtensionDefinition<{
lineClamp: number;
noTrack: boolean;
}>;
plugins/catalog-react/api-report-alpha.md
+7 -5
View File
@@ -8,7 +8,7 @@
import { AnyExtensionInputMap } from '@backstage/frontend-plugin-api';
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Entity } from '@backstage/catalog-model';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExtensionInputValues } from '@backstage/frontend-plugin-api';
import { ResourcePermission } from '@backstage/plugin-permission-common';
import { RouteRef } from '@backstage/frontend-plugin-api';
@@ -17,7 +17,8 @@ import { RouteRef } from '@backstage/frontend-plugin-api';
export function createEntityCardExtension<
TInputs extends AnyExtensionInputMap,
>(options: {
id: string;
namespace?: string;
name?: string;
attachTo?: {
id: string;
input: string;
@@ -30,7 +31,7 @@ export function createEntityCardExtension<
loader: (options: {
inputs: Expand<ExtensionInputValues<TInputs>>;
}) => Promise<JSX.Element>;
}): Extension<{
}): ExtensionDefinition<{
filter?: string | undefined;
}>;
@@ -38,7 +39,8 @@ export function createEntityCardExtension<
export function createEntityContentExtension<
TInputs extends AnyExtensionInputMap,
>(options: {
id: string;
namespace?: string;
name?: string;
attachTo?: {
id: string;
input: string;
@@ -54,7 +56,7 @@ export function createEntityContentExtension<
loader: (options: {
inputs: Expand<ExtensionInputValues<TInputs>>;
}) => Promise<JSX.Element>;
}): Extension<{
}): ExtensionDefinition<{
title: string;
path: string;
filter?: string | undefined;
plugins/catalog/api-report-alpha.md
+4 -3
View File
@@ -7,7 +7,7 @@
import { AnyExtensionInputMap } from '@backstage/frontend-plugin-api';
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ExternalRouteRef } from '@backstage/frontend-plugin-api';
import { PortableSchema } from '@backstage/frontend-plugin-api';
import { RouteRef } from '@backstage/frontend-plugin-api';
@@ -17,11 +17,12 @@ export function createCatalogFilterExtension<
TInputs extends AnyExtensionInputMap,
TConfig = never,
>(options: {
id: string;
namespace?: string;
name?: string;
inputs?: TInputs;
configSchema?: PortableSchema<TConfig>;
loader: (options: { config: TConfig }) => Promise<JSX.Element>;
}): Extension<TConfig>;
}): ExtensionDefinition<TConfig>;
// @alpha (undocumented)
const _default: BackstagePlugin<
plugins/explore/api-report-alpha.md
+2 -2
View File
@@ -4,14 +4,14 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
const _default: BackstagePlugin<{}, {}>;
export default _default;
// @alpha (undocumented)
export const ExploreSearchResultListItemExtension: Extension<{
export const ExploreSearchResultListItemExtension: ExtensionDefinition<{
noTrack?: boolean | undefined;
}>;
plugins/graphiql/api-report-alpha.md
+8 -7
View File
@@ -4,20 +4,21 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { GraphQLEndpoint } from '@backstage/plugin-graphiql';
import { PortableSchema } from '@backstage/frontend-plugin-api';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
export function createEndpointExtension<TConfig extends {}>(options: {
id: string;
export function createGraphiQLEndpointExtension<TConfig extends {}>(options: {
namespace?: string;
name?: string;
configSchema?: PortableSchema<TConfig>;
disabled?: boolean;
factory: (options: { config: TConfig }) => {
endpoint: GraphQLEndpoint;
};
}): Extension<TConfig>;
}): ExtensionDefinition<TConfig>;
// @alpha (undocumented)
const _default: BackstagePlugin<
@@ -29,15 +30,15 @@ const _default: BackstagePlugin<
export default _default;
// @alpha (undocumented)
export const graphiqlBrowseApi: Extension<{}>;
export const graphiqlBrowseApi: ExtensionDefinition<{}>;
// @alpha (undocumented)
export const GraphiqlPage: Extension<{
export const GraphiqlPage: ExtensionDefinition<{
path: string;
}>;
// @alpha (undocumented)
export const graphiqlPageSidebarItem: Extension<{
export const graphiqlPageSidebarItem: ExtensionDefinition<{
title: string;
}>;
plugins/search-react/api-report-alpha.md
+6 -3
View File
@@ -6,7 +6,7 @@
/// <reference types="react" />
import { ConfigurableExtensionDataRef } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { ListItemProps } from '@material-ui/core';
import { PortableSchema } from '@backstage/frontend-plugin-api';
import { SearchDocument } from '@backstage/plugin-search-common';
@@ -23,7 +23,9 @@ export function createSearchResultListItemExtension<
TConfig extends {
noTrack?: boolean;
},
>(options: SearchResultItemExtensionOptions<TConfig>): Extension<TConfig>;
>(
options: SearchResultItemExtensionOptions<TConfig>,
): ExtensionDefinition<TConfig>;
// @alpha (undocumented)
export type SearchResultItemExtensionComponent = <
@@ -47,7 +49,8 @@ export type SearchResultItemExtensionOptions<
noTrack?: boolean;
},
> = {
id: string;
namespace?: string;
name?: string;
attachTo?: {
id: string;
input: string;
plugins/search/api-report-alpha.md
+4 -4
View File
@@ -4,7 +4,7 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
@@ -17,15 +17,15 @@ const _default: BackstagePlugin<
export default _default;
// @alpha (undocumented)
export const SearchApi: Extension<{}>;
export const SearchApi: ExtensionDefinition<{}>;
// @alpha (undocumented)
export const SearchNavItem: Extension<{
export const SearchNavItem: ExtensionDefinition<{
title: string;
}>;
// @alpha (undocumented)
export const SearchPage: Extension<{
export const SearchPage: ExtensionDefinition<{
path: string;
noTrack: boolean;
}>;
plugins/tech-radar/api-report-alpha.md
+5 -2
View File
@@ -4,7 +4,7 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
@@ -17,7 +17,10 @@ const _default: BackstagePlugin<
export default _default;
// @alpha (undocumented)
export const TechRadarPage: Extension<{
export const sampleTechRadarApi: ExtensionDefinition<{}>;
// @alpha (undocumented)
export const TechRadarPage: ExtensionDefinition<{
height: number;
width: number;
title: string;
plugins/tech-radar/src/alpha.tsx
+1
View File
@@ -47,6 +47,7 @@ export const TechRadarPage = createPageExtension({
import('./components').then(m => <m.RadarPage {...config} />),
});
/** @alpha */
export const sampleTechRadarApi = createApiExtension({
factory() {
return createApiFactory(techRadarApiRef, new SampleTechRadarApi());
plugins/techdocs/api-report-alpha.md
+2 -2
View File
@@ -4,7 +4,7 @@
```ts
import { BackstagePlugin } from '@backstage/frontend-plugin-api';
import { Extension } from '@backstage/frontend-plugin-api';
import { ExtensionDefinition } from '@backstage/frontend-plugin-api';
import { RouteRef } from '@backstage/frontend-plugin-api';
// @alpha (undocumented)
@@ -23,7 +23,7 @@ const _default: BackstagePlugin<
export default _default;
// @alpha (undocumented)
export const TechDocsSearchResultListItemExtension: Extension<{
export const TechDocsSearchResultListItemExtension: ExtensionDefinition<{
lineClamp: number;
noTrack: boolean;
asListItem: boolean;