diff --git a/plugins/techdocs-react/report.api.md b/plugins/techdocs-react/report.api.md index fd8de5803f..a3bae1f571 100644 --- a/plugins/techdocs-react/report.api.md +++ b/plugins/techdocs-react/report.api.md @@ -21,7 +21,11 @@ import { SetStateAction } from 'react'; // @public export const buildTechDocsURL: ( entity: Entity, - routeFunc: TechDocsRouteFunc | undefined, + routeFunc: RouteFunc<{ + namespace: string; + kind: string; + name: string; + }> | undefined, ) => string | undefined; // @public @@ -132,13 +136,6 @@ export type TechDocsReaderPageValue = { onReady?: () => void; }; -// @public -export type TechDocsRouteFunc = RouteFunc<{ - namespace: string; - kind: string; - name: string; -}>; - // @public export const TechDocsShadowDom: ( props: TechDocsShadowDomProps, diff --git a/plugins/techdocs-react/src/helpers.ts b/plugins/techdocs-react/src/helpers.ts index 8c4c9ee8f1..e6daf99b26 100644 --- a/plugins/techdocs-react/src/helpers.ts +++ b/plugins/techdocs-react/src/helpers.ts @@ -27,18 +27,6 @@ import { } from '@backstage/plugin-techdocs-common'; import { RouteFunc } from '@backstage/core-plugin-api'; -/** - * The RouteFunc used by buildTechDocsURL() to build the TechDocs link for - * an entity. - * - * @public - */ -export type TechDocsRouteFunc = RouteFunc<{ - namespace: string; - kind: string; - name: string; -}>; - /** * Lower-case entity triplets by default, but allow override. * @@ -82,7 +70,13 @@ export function getEntityRootTechDocsPath(entity: Entity): string { */ export const buildTechDocsURL = ( entity: Entity, - routeFunc: TechDocsRouteFunc | undefined, + routeFunc: + | RouteFunc<{ + namespace: string; + kind: string; + name: string; + }> + | undefined, ) => { if (!routeFunc) { return undefined; diff --git a/plugins/techdocs-react/src/index.ts b/plugins/techdocs-react/src/index.ts index 6b0e228a27..7c4f316c1e 100644 --- a/plugins/techdocs-react/src/index.ts +++ b/plugins/techdocs-react/src/index.ts @@ -57,4 +57,3 @@ export { getEntityRootTechDocsPath, buildTechDocsURL, } from './helpers'; -export type { TechDocsRouteFunc } from './helpers';