plugins: generate api reports

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
2021-06-17 11:00:16 +02:00
parent 5429bfa69e
commit d8d7226fce
54 changed files with 5209 additions and 0 deletions
@@ -0,0 +1,115 @@
+## API Report File for "@backstage/plugin-api-docs"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiEntity } from '@backstage/catalog-model';
+import { ApiRef } from '@backstage/core';
+import { BackstagePlugin } from '@backstage/core';
+import { CatalogTableRow } from '@backstage/plugin-catalog';
+import { Entity } from '@backstage/catalog-model';
+import { ExternalRouteRef } from '@backstage/core';
+import { default as React_2 } from 'react';
+import { RouteRef } from '@backstage/core';
+import { TableColumn } from '@backstage/core';
+import { UserListFilterKind } from '@backstage/plugin-catalog-react';
+
+// @public (undocumented)
+export const ApiDefinitionCard: (_: Props) => JSX.Element;
+
+// @public (undocumented)
+export type ApiDefinitionWidget = {
+    type: string;
+    title: string;
+    component: (definition: string) => React_2.ReactElement;
+    rawLanguage?: string;
+};
+
+// @public (undocumented)
+export const apiDocsConfigRef: ApiRef<ApiDocsConfig>;
+
+// @public (undocumented)
+const apiDocsPlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+}, {
+    createComponent: ExternalRouteRef<undefined, true>;
+}>;
+
+export { apiDocsPlugin }
+
+export { apiDocsPlugin as plugin }
+
+// @public (undocumented)
+export const ApiExplorerPage: ({ initiallySelectedFilter, columns, }: ApiExplorerPageProps) => JSX.Element;
+
+// @public (undocumented)
+export const ApiTypeTitle: ({ apiEntity }: {
+    apiEntity: ApiEntity;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const AsyncApiDefinitionWidget: ({ definition }: Props_5) => JSX.Element;
+
+// @public (undocumented)
+export const ConsumedApisCard: ({ variant }: Props_2) => JSX.Element;
+
+// @public (undocumented)
+export const ConsumingComponentsCard: ({ variant }: Props_6) => JSX.Element;
+
+// @public (undocumented)
+export function defaultDefinitionWidgets(): ApiDefinitionWidget[];
+
+// @public (undocumented)
+export const EntityApiDefinitionCard: (_: {
+    apiEntity?: ApiEntity | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityConsumedApisCard: ({ variant }: {
+    entity?: Entity| undefined;
+    variant?: "gridItem" | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityConsumingComponentsCard: ({ variant }: {
+    entity?: Entity| undefined;
+    variant?: "gridItem" | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityHasApisCard: ({ variant }: {
+    variant?: "gridItem" | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityProvidedApisCard: ({ variant }: {
+    entity?: Entity| undefined;
+    variant?: "gridItem" | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const EntityProvidingComponentsCard: ({ variant }: {
+    entity?: Entity| undefined;
+    variant?: "gridItem" | undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const HasApisCard: ({ variant }: Props_3) => JSX.Element;
+
+// @public (undocumented)
+export const OpenApiDefinitionWidget: ({ definition }: Props_8) => JSX.Element;
+
+// @public (undocumented)
+export const PlainApiDefinitionWidget: ({ definition, language }: Props_9) => JSX.Element;
+
+// @public (undocumented)
+export const ProvidedApisCard: ({ variant }: Props_4) => JSX.Element;
+
+// @public (undocumented)
+export const ProvidingComponentsCard: ({ variant }: Props_7) => JSX.Element;
+
+
+// (No @packageDocumentation comment for this package)
+
+```