Skip to content

Latest commit

 

History

History
234 lines (197 loc) · 6.43 KB

report.api.md

File metadata and controls

234 lines (197 loc) · 6.43 KB

API Report File for "@backstage/plugin-api-docs"

Do not edit this file. It is a report generated by API Extractor.

/// <reference types="react" />

import { ApiEntity } from '@backstage/catalog-model';
import { ApiRef } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogTableRow } from '@backstage/plugin-catalog';
import { ComponentEntity } from '@backstage/catalog-model';
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 { RouteRef } from '@backstage/core-plugin-api';
import { TableColumn } from '@backstage/core-components';
import { TableOptions } from '@backstage/core-components';
import { TableProps } from '@backstage/core-components';
import { UserListFilterKind } from '@backstage/plugin-catalog-react';

// @public (undocumented)
export const ApiDefinitionCard: () => React_2.JSX.Element;

// @public
export function ApiDefinitionDialog(props: {
  open: boolean;
  entity: ApiEntity;
  onClose: () => void;
}): React_2.JSX.Element;

// @public (undocumented)
export type ApiDefinitionWidget = {
  type: string;
  title: string;
  component: (definition: string) => React_2.ReactElement;
  rawLanguage?: string;
};

// @public (undocumented)
export interface ApiDocsConfig {
  // (undocumented)
  getApiDefinitionWidget: (
    apiEntity: ApiEntity,
  ) => ApiDefinitionWidget | undefined;
}

// @public (undocumented)
export const apiDocsConfigRef: ApiRef<ApiDocsConfig>;

// @public (undocumented)
const apiDocsPlugin: BackstagePlugin<
  {
    root: RouteRef<undefined>;
  },
  {
    registerApi: ExternalRouteRef<undefined, true>;
  }
>;
export { apiDocsPlugin };
export { apiDocsPlugin as plugin };

// @public
export const ApiExplorerIndexPage: (
  props: DefaultApiExplorerPageProps,
) => React_2.JSX.Element;

// @public (undocumented)
export const ApiExplorerPage: (
  props: DefaultApiExplorerPageProps,
) => JSX_2.Element;

// @public (undocumented)
export const ApiTypeTitle: (props: {
  apiEntity: ApiEntity;
}) => React_2.JSX.Element;

// @public (undocumented)
export const AsyncApiDefinitionWidget: (
  props: AsyncApiDefinitionWidgetProps,
) => React_2.JSX.Element;

// @public (undocumented)
export type AsyncApiDefinitionWidgetProps = {
  definition: string;
  resolvers?: AsyncApiResolver[];
};

// @public (undocumented)
export type AsyncApiResolver = {
  schema: string;
  order: number;
  canRead: boolean;
  read(uri: any): Promise<string>;
};

// @public (undocumented)
export const ConsumedApisCard: (props: {
  variant?: InfoCardVariants;
  title?: string;
  columns?: TableColumn<ApiEntity>[];
  tableOptions?: TableOptions;
}) => React_2.JSX.Element;

// @public (undocumented)
export const ConsumingComponentsCard: (props: {
  variant?: InfoCardVariants;
  columns?: TableColumn<ComponentEntity>[];
}) => React_2.JSX.Element;

// @public
export const DefaultApiExplorerPage: (
  props: DefaultApiExplorerPageProps,
) => React_2.JSX.Element;

// @public
export type DefaultApiExplorerPageProps = {
  initiallySelectedFilter?: UserListFilterKind;
  columns?: TableColumn<CatalogTableRow>[];
  actions?: TableProps<CatalogTableRow>['actions'];
  ownerPickerMode?: EntityOwnerPickerProps['mode'];
  pagination?: EntityListPagination;
};

// @public (undocumented)
export function defaultDefinitionWidgets(): ApiDefinitionWidget[];

// @public (undocumented)
export const EntityApiDefinitionCard: () => JSX_2.Element;

// @public (undocumented)
export const EntityConsumedApisCard: (props: {
  variant?: InfoCardVariants | undefined;
  title?: string | undefined;
  columns?: TableColumn<ApiEntity>[] | undefined;
  tableOptions?: TableOptions<{}> | undefined;
}) => JSX_2.Element;

// @public (undocumented)
export const EntityConsumingComponentsCard: (props: {
  variant?: InfoCardVariants | undefined;
  columns?: TableColumn<ComponentEntity>[] | undefined;
}) => JSX_2.Element;

// @public (undocumented)
export const EntityHasApisCard: (props: {
  variant?: InfoCardVariants | undefined;
  title?: string | undefined;
  columns?: TableColumn<ApiEntity>[] | undefined;
  tableOptions?: TableOptions<{}> | undefined;
}) => JSX_2.Element;

// @public (undocumented)
export const EntityProvidedApisCard: (props: {
  variant?: InfoCardVariants | undefined;
  title?: string | undefined;
  columns?: TableColumn<ApiEntity>[] | undefined;
  tableOptions?: TableOptions<{}> | undefined;
}) => JSX_2.Element;

// @public (undocumented)
export const EntityProvidingComponentsCard: (props: {
  variant?: InfoCardVariants | undefined;
  columns?: TableColumn<ComponentEntity>[] | undefined;
}) => JSX_2.Element;

// @public (undocumented)
export const GraphQlDefinitionWidget: (
  props: GraphQlDefinitionWidgetProps,
) => React_2.JSX.Element;

// @public (undocumented)
export type GraphQlDefinitionWidgetProps = {
  definition: string;
};

// @public (undocumented)
export const HasApisCard: (props: {
  variant?: InfoCardVariants;
  title?: string;
  columns?: TableColumn<ApiEntity>[];
  tableOptions?: TableOptions;
}) => React_2.JSX.Element;

// @public (undocumented)
export const OpenApiDefinitionWidget: (
  props: OpenApiDefinitionWidgetProps,
) => React_2.JSX.Element;

// @public (undocumented)
export type OpenApiDefinitionWidgetProps = {
  definition: string;
  requestInterceptor?: (req: any) => any | Promise<any>;
  supportedSubmitMethods?: string[];
};

// @public (undocumented)
export const PlainApiDefinitionWidget: (
  props: PlainApiDefinitionWidgetProps,
) => React_2.JSX.Element;

// @public (undocumented)
export type PlainApiDefinitionWidgetProps = {
  definition: any;
  language: string;
};

// @public (undocumented)
export const ProvidedApisCard: (props: {
  variant?: InfoCardVariants;
  title?: string;
  columns?: TableColumn<ApiEntity>[];
  tableOptions?: TableOptions;
}) => React_2.JSX.Element;

// @public (undocumented)
export const ProvidingComponentsCard: (props: {
  variant?: InfoCardVariants;
  columns?: TableColumn<ComponentEntity>[];
}) => React_2.JSX.Element;

// @public (undocumented)
export const TrpcApiDefinitionWidget: (
  props: TrpcApiDefinitionWidgetProps,
) => React_2.JSX.Element;

// @public (undocumented)
export type TrpcApiDefinitionWidgetProps = {
  definition: string;
};