From dc949c8073a09c1e393f83b21ba371f6cc018450 Mon Sep 17 00:00:00 2001 From: benjdlambert Date: Thu, 17 Apr 2025 10:18:40 +0200 Subject: [PATCH 1/3] `templateExtensions` -> `templatingExtensions` Signed-off-by: benjdlambert --- plugins/scaffolder-backend/src/service/router.test.ts | 4 ++-- plugins/scaffolder-backend/src/service/router.ts | 2 +- plugins/scaffolder-react/report.api.md | 4 ++-- plugins/scaffolder-react/src/api/types.ts | 4 ++-- plugins/scaffolder/report.api.md | 4 ++-- plugins/scaffolder/src/api.ts | 4 ++-- 6 files changed, 11 insertions(+), 11 deletions(-) diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts index f97bad35c8..8afc5230da 100644 --- a/plugins/scaffolder-backend/src/service/router.test.ts +++ b/plugins/scaffolder-backend/src/service/router.test.ts @@ -360,10 +360,10 @@ describe.each([ }); }); - describe('GET /v2/template-extensions', () => { + describe('GET /v2/temlating-extensions', () => { it('lists template filters and globals', async () => { const response = await request(app) - .get('/v2/template-extensions') + .get('/v2/temlating-extensions') .send(); expect(response.status).toEqual(200); const integrations = ScmIntegrations.fromConfig(config); diff --git a/plugins/scaffolder-backend/src/service/router.ts b/plugins/scaffolder-backend/src/service/router.ts index def470252d..e5c384987a 100644 --- a/plugins/scaffolder-backend/src/service/router.ts +++ b/plugins/scaffolder-backend/src/service/router.ts @@ -1115,7 +1115,7 @@ export async function createRouter( res.status(200).json({ results }); }) - .get('/v2/template-extensions', async (_req, res) => { + .get('/v2/templating-extensions', async (_req, res) => { res.status(200).json({ filters: { ...extractFilterMetadata(createDefaultFilters({ integrations })), diff --git a/plugins/scaffolder-react/report.api.md b/plugins/scaffolder-react/report.api.md index cd8711b18f..d66ec36acb 100644 --- a/plugins/scaffolder-react/report.api.md +++ b/plugins/scaffolder-react/report.api.md @@ -166,7 +166,7 @@ export type LayoutTemplate = NonNullable< export type ListActionsResponse = Array; // @public -export type ListTemplateExtensionsResponse = { +export type ListTemplatingExtensionsResponse = { filters: Record; globals: { functions: Record; @@ -247,7 +247,7 @@ export interface ScaffolderApi { tasks: ScaffolderTask[]; totalTasks?: number; }>; - listTemplateExtensions?(): Promise; + listTemplatingExtensions?(): Promise; retry?(taskId: string): Promise; scaffold( options: ScaffolderScaffoldOptions, diff --git a/plugins/scaffolder-react/src/api/types.ts b/plugins/scaffolder-react/src/api/types.ts index cb73704010..acc980afdc 100644 --- a/plugins/scaffolder-react/src/api/types.ts +++ b/plugins/scaffolder-react/src/api/types.ts @@ -129,7 +129,7 @@ export type TemplateGlobalValue = { * * @public */ -export type ListTemplateExtensionsResponse = { +export type ListTemplatingExtensionsResponse = { filters: Record; globals: { functions: Record; @@ -300,7 +300,7 @@ export interface ScaffolderApi { /** * Returns a structure describing the available templating extensions. */ - listTemplateExtensions?(): Promise; + listTemplatingExtensions?(): Promise; streamLogs(options: ScaffolderStreamLogsOptions): Observable; diff --git a/plugins/scaffolder/report.api.md b/plugins/scaffolder/report.api.md index a685e8163f..927599b91f 100644 --- a/plugins/scaffolder/report.api.md +++ b/plugins/scaffolder/report.api.md @@ -25,7 +25,7 @@ import { JSX as JSX_2 } from 'react/jsx-runtime'; import { LayoutOptions as LayoutOptions_2 } from '@backstage/plugin-scaffolder-react'; import { LayoutTemplate as LayoutTemplate_2 } from '@backstage/plugin-scaffolder-react'; import { ListActionsResponse as ListActionsResponse_2 } from '@backstage/plugin-scaffolder-react'; -import { ListTemplateExtensionsResponse } from '@backstage/plugin-scaffolder-react'; +import { ListTemplatingExtensionsResponse } from '@backstage/plugin-scaffolder-react'; import { LogEvent as LogEvent_2 } from '@backstage/plugin-scaffolder-react'; import { Observable } from '@backstage/types'; import { PathParams } from '@backstage/core-plugin-api'; @@ -561,7 +561,7 @@ export class ScaffolderClient implements ScaffolderApi_2 { totalTasks?: number; }>; // (undocumented) - listTemplateExtensions(): Promise; + listTemplatingExtensions(): Promise; // (undocumented) retry?(taskId: string): Promise; // (undocumented) diff --git a/plugins/scaffolder/src/api.ts b/plugins/scaffolder/src/api.ts index 85450b012a..1121593e2d 100644 --- a/plugins/scaffolder/src/api.ts +++ b/plugins/scaffolder/src/api.ts @@ -24,7 +24,7 @@ import { ResponseError } from '@backstage/errors'; import { ScmIntegrationRegistry } from '@backstage/integration'; import { ListActionsResponse, - ListTemplateExtensionsResponse, + ListTemplatingExtensionsResponse, LogEvent, ScaffolderApi, ScaffolderDryRunOptions, @@ -325,7 +325,7 @@ export class ScaffolderClient implements ScaffolderApi { return await response.json(); } - async listTemplateExtensions(): Promise { + async listTemplatingExtensions(): Promise { const baseUrl = await this.discoveryApi.getBaseUrl('scaffolder'); const response = await this.fetchApi.fetch( `${baseUrl}/v2/template-extensions`, From 36ae651c5b03dfa15b61ab5ede62fc94f32d1f18 Mon Sep 17 00:00:00 2001 From: benjdlambert Date: Thu, 17 Apr 2025 10:19:40 +0200 Subject: [PATCH 2/3] chore: added changetset Signed-off-by: benjdlambert --- .changeset/shiny-symbols-grow.md | 7 +++++++ 1 file changed, 7 insertions(+) create mode 100644 .changeset/shiny-symbols-grow.md diff --git a/.changeset/shiny-symbols-grow.md b/.changeset/shiny-symbols-grow.md new file mode 100644 index 0000000000..ea283a2f97 --- /dev/null +++ b/.changeset/shiny-symbols-grow.md @@ -0,0 +1,7 @@ +--- +'@backstage/plugin-scaffolder-backend': patch +'@backstage/plugin-scaffolder-react': patch +'@backstage/plugin-scaffolder': patch +--- + +Fixing a bug where the name for `templatingExtensions` was incorrect From db72bc960ddeff40d94def366311e5b09ac6e50f Mon Sep 17 00:00:00 2001 From: benjdlambert Date: Thu, 17 Apr 2025 10:21:27 +0200 Subject: [PATCH 3/3] chore: Fix the name of the route in the test Signed-off-by: benjdlambert --- .changeset/shiny-symbols-grow.md | 2 +- plugins/scaffolder-backend/src/service/router.test.ts | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.changeset/shiny-symbols-grow.md b/.changeset/shiny-symbols-grow.md index ea283a2f97..18dd3b8b1f 100644 --- a/.changeset/shiny-symbols-grow.md +++ b/.changeset/shiny-symbols-grow.md @@ -4,4 +4,4 @@ '@backstage/plugin-scaffolder': patch --- -Fixing a bug where the name for `templatingExtensions` was incorrect +Fixing a bug where the name for `templatingExtensions` was incorrectly set to `templateExtensions` diff --git a/plugins/scaffolder-backend/src/service/router.test.ts b/plugins/scaffolder-backend/src/service/router.test.ts index 8afc5230da..d26cc955b3 100644 --- a/plugins/scaffolder-backend/src/service/router.test.ts +++ b/plugins/scaffolder-backend/src/service/router.test.ts @@ -360,10 +360,10 @@ describe.each([ }); }); - describe('GET /v2/temlating-extensions', () => { + describe('GET /v2/templating-extensions', () => { it('lists template filters and globals', async () => { const response = await request(app) - .get('/v2/temlating-extensions') + .get('/v2/templating-extensions') .send(); expect(response.status).toEqual(200); const integrations = ScmIntegrations.fromConfig(config);