From 027bc50cc569e93cc482567f05f49e4777ea19f3 Mon Sep 17 00:00:00 2001 From: Kamil Zainal Date: Tue, 18 Jan 2022 18:12:36 +0000 Subject: [PATCH] Rename registerComponent to registerApi to better communicate intent Signed-off-by: Kamil Zainal --- .changeset/friendly-weeks-cry.md | 2 +- .../create-app/templates/default-app/packages/app/src/App.tsx | 2 +- plugins/api-docs/api-report.md | 2 +- plugins/api-docs/src/plugin.ts | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.changeset/friendly-weeks-cry.md b/.changeset/friendly-weeks-cry.md index dfe5765d49..e98be44f06 100644 --- a/.changeset/friendly-weeks-cry.md +++ b/.changeset/friendly-weeks-cry.md @@ -13,7 +13,7 @@ const App = createApp({ ... bind(apiDocsPlugin.externalRoutes, { - createComponent: scaffolderPlugin.routes.root, -+ registerComponent: catalogImportPlugin.routes.importPage, ++ registerApi: catalogImportPlugin.routes.importPage, }); ... }, diff --git a/packages/create-app/templates/default-app/packages/app/src/App.tsx b/packages/create-app/templates/default-app/packages/app/src/App.tsx index b6aa88ff9e..4c284e9c9a 100644 --- a/packages/create-app/templates/default-app/packages/app/src/App.tsx +++ b/packages/create-app/templates/default-app/packages/app/src/App.tsx @@ -37,7 +37,7 @@ const app = createApp({ viewTechDoc: techdocsPlugin.routes.docRoot, }); bind(apiDocsPlugin.externalRoutes, { - registerComponent: catalogImportPlugin.routes.importPage, + registerApi: catalogImportPlugin.routes.importPage, }); bind(scaffolderPlugin.externalRoutes, { registerComponent: catalogImportPlugin.routes.importPage, diff --git a/plugins/api-docs/api-report.md b/plugins/api-docs/api-report.md index ccae9e7d47..3bc6f4070a 100644 --- a/plugins/api-docs/api-report.md +++ b/plugins/api-docs/api-report.md @@ -47,7 +47,7 @@ const apiDocsPlugin: BackstagePlugin< root: RouteRef; }, { - registerComponent: ExternalRouteRef; + registerApi: ExternalRouteRef; } >; export { apiDocsPlugin }; diff --git a/plugins/api-docs/src/plugin.ts b/plugins/api-docs/src/plugin.ts index 4b69cc85ff..f1928f4443 100644 --- a/plugins/api-docs/src/plugin.ts +++ b/plugins/api-docs/src/plugin.ts @@ -45,7 +45,7 @@ export const apiDocsPlugin = createPlugin({ }), ], externalRoutes: { - registerComponent: registerComponentRouteRef, + registerApi: registerComponentRouteRef, }, });