frontend-plugin-api,catalog-react: remove default* prefix from blueprint params

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
Patrik Oldsberg
2025-08-01 14:41:21 +02:00
parent 9ad8a1d30e
commit e4ddf22854
68 changed files with 275 additions and 176 deletions
+1 -1
View File
@@ -287,7 +287,7 @@ export default createFrontendModule({
createPageExtension({
// Omitting name since we are overriding a plugin index page
// It's up to you whether to use the original default path or not, but links that are hardcoded to the default path won't work if you change it
defaultPath: '/api-docs',
path: '/api-docs',
// Associating the page with a different route ref may result in the sidebar item or external plugin route pointing to an unreachable page
routeRef: convertLegacyRouteRef(rootRoute),
// Custom page components are loaded here
+14 -7
View File
@@ -382,10 +382,13 @@ const _default: FrontendPlugin<
>;
inputs: {};
params: {
defaultPath?: [Error: `Use the 'path' param instead`];
path: string;
defaultTitle?: [Error: `Use the 'title' param instead`];
title: string;
defaultGroup?: [Error: `Use the 'group' param instead`];
group?: keyof defaultEntityContentGroups | (string & {});
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
@@ -443,10 +446,13 @@ const _default: FrontendPlugin<
>;
inputs: {};
params: {
defaultPath?: [Error: `Use the 'path' param instead`];
path: string;
defaultTitle?: [Error: `Use the 'title' param instead`];
title: string;
defaultGroup?: [Error: `Use the 'group' param instead`];
group?: keyof defaultEntityContentGroups | (string & {});
loader: () => Promise<JSX.Element>;
defaultPath: string;
defaultTitle: string;
defaultGroup?: keyof defaultEntityContentGroups | (string & {});
routeRef?: RouteRef;
filter?: string | EntityPredicate | ((entity: Entity) => boolean);
};
@@ -505,7 +511,8 @@ const _default: FrontendPlugin<
kind: 'page';
name: undefined;
params: {
defaultPath: string;
defaultPath?: [Error: `Use the 'path' param instead`];
path: string;
loader: () => Promise<JSX.Element>;
routeRef?: RouteRef;
};
+5 -5
View File
@@ -79,7 +79,7 @@ const apiDocsExplorerPage = PageBlueprint.makeWithOverrides({
},
factory(originalFactory, { config }) {
return originalFactory({
defaultPath: '/api-docs',
path: '/api-docs',
routeRef: convertLegacyRouteRef(rootRoute),
loader: () =>
import('./components/ApiExplorerPage').then(m =>
@@ -186,8 +186,8 @@ const apiDocsProvidingComponentsEntityCard = EntityCardBlueprint.make({
const apiDocsDefinitionEntityContent = EntityContentBlueprint.make({
name: 'definition',
params: {
defaultPath: '/definition',
defaultTitle: 'Definition',
path: '/definition',
title: 'Definition',
filter: 'kind:api',
loader: async () =>
import('./components/ApiDefinitionCard').then(m =>
@@ -205,8 +205,8 @@ const apiDocsDefinitionEntityContent = EntityContentBlueprint.make({
const apiDocsApisEntityContent = EntityContentBlueprint.make({
name: 'apis',
params: {
defaultPath: '/apis',
defaultTitle: 'APIs',
path: '/apis',
title: 'APIs',
filter: 'kind:component',
loader: async () =>
import('./components/ApisCards').then(m =>