Merge pull request #6076 from backstage/rugvip/allreports

scripts/api-extractor: create and check API reports for all(most) plugins
2021-06-17 15:46:11 +02:00
parent 79a5fc65a8 d8d7226fce
commit 820de63018
55 changed files with 5261 additions and 22 deletions
@@ -0,0 +1,146 @@
+## API Report File for "@backstage/plugin-techdocs"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ApiRef } from '@backstage/core';
+import { BackstagePlugin } from '@backstage/core';
+import { Config } from '@backstage/config';
+import { CSSProperties } from '@material-ui/styles';
+import { DiscoveryApi } from '@backstage/core';
+import { Entity } from '@backstage/catalog-model';
+import { EntityName } from '@backstage/catalog-model';
+import { IdentityApi } from '@backstage/core';
+import { Location as Location_2 } from '@backstage/catalog-model';
+import { RouteRef } from '@backstage/core';
+
+// @public (undocumented)
+export const DocsCardGrid: ({ entities, }: {
+    entities: Entity[] | undefined;
+}) => JSX.Element | null;
+
+// @public (undocumented)
+export const DocsTable: ({ entities, title, }: {
+    entities: Entity[] | undefined;
+    title?: string | undefined;
+}) => JSX.Element | null;
+
+// @public (undocumented)
+export const EmbeddedDocsRouter: (_props: Props) => JSX.Element;
+
+// @public (undocumented)
+export const EntityTechdocsContent: (_props: {
+    entity?: Entity| undefined;
+}) => JSX.Element;
+
+// @public (undocumented)
+export type PanelType = 'DocsCardGrid' | 'DocsTable';
+
+// @public (undocumented)
+export const Reader: ({ entityId, onReady }: Props_2) => JSX.Element;
+
+// @public (undocumented)
+export const Router: () => JSX.Element;
+
+// @public (undocumented)
+export interface TechDocsApi {
+    // (undocumented)
+    getApiOrigin(): Promise<string>;
+    // (undocumented)
+    getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
+    // (undocumented)
+    getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
+}
+
+// @public (undocumented)
+export const techdocsApiRef: ApiRef<TechDocsApi>;
+
+// @public
+export class TechDocsClient implements TechDocsApi {
+    constructor({ configApi, discoveryApi, identityApi, }: {
+        configApi: Config;
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+    });
+    // (undocumented)
+    configApi: Config;
+    // (undocumented)
+    discoveryApi: DiscoveryApi;
+    // (undocumented)
+    getApiOrigin(): Promise<string>;
+    getEntityMetadata(entityId: EntityName): Promise<TechDocsEntityMetadata>;
+    getTechDocsMetadata(entityId: EntityName): Promise<TechDocsMetadata>;
+    // (undocumented)
+    identityApi: IdentityApi;
+}
+
+// @public (undocumented)
+export const TechDocsCustomHome: ({ tabsConfig, }: {
+    tabsConfig: TabsConfig;
+}) => JSX.Element;
+
+// @public (undocumented)
+export const TechdocsPage: () => JSX.Element;
+
+// @public (undocumented)
+const techdocsPlugin: BackstagePlugin<{
+    root: RouteRef<undefined>;
+    entityContent: RouteRef<undefined>;
+}, {}>;
+
+export { techdocsPlugin as plugin }
+
+export { techdocsPlugin }
+
+// @public (undocumented)
+export const TechDocsReaderPage: () => JSX.Element;
+
+// @public (undocumented)
+export interface TechDocsStorageApi {
+    // (undocumented)
+    getApiOrigin(): Promise<string>;
+    // (undocumented)
+    getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
+    // (undocumented)
+    getBuilder(): Promise<string>;
+    // (undocumented)
+    getEntityDocs(entityId: EntityName, path: string): Promise<string>;
+    // (undocumented)
+    getStorageUrl(): Promise<string>;
+    // (undocumented)
+    syncEntityDocs(entityId: EntityName): Promise<boolean>;
+}
+
+// @public (undocumented)
+export const techdocsStorageApiRef: ApiRef<TechDocsStorageApi>;
+
+// @public
+export class TechDocsStorageClient implements TechDocsStorageApi {
+    constructor({ configApi, discoveryApi, identityApi, }: {
+        configApi: Config;
+        discoveryApi: DiscoveryApi;
+        identityApi: IdentityApi;
+    });
+    // (undocumented)
+    configApi: Config;
+    // (undocumented)
+    discoveryApi: DiscoveryApi;
+    // (undocumented)
+    getApiOrigin(): Promise<string>;
+    // (undocumented)
+    getBaseUrl(oldBaseUrl: string, entityId: EntityName, path: string): Promise<string>;
+    // (undocumented)
+    getBuilder(): Promise<string>;
+    getEntityDocs(entityId: EntityName, path: string): Promise<string>;
+    // (undocumented)
+    getStorageUrl(): Promise<string>;
+    // (undocumented)
+    identityApi: IdentityApi;
+    syncEntityDocs(entityId: EntityName): Promise<boolean>;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```