todo - Deprecated legacy backend (#2053)

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
backstage · Nov 26, 2024 · b23745f · b23745f
1 parent 14a35d5
commit b23745f
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 4 deletions.
diff --git a/workspaces/todo/.changeset/fluffy-phones-tie.md b/workspaces/todo/.changeset/fluffy-phones-tie.md
@@ -0,0 +1,5 @@
+---
+'@backstage-community/plugin-todo-backend': patch
+---
+
+Deprecated `createRouter` and its router options in favour of the new backend system.
diff --git a/workspaces/todo/plugins/todo-backend/report.api.md b/workspaces/todo/plugins/todo-backend/report.api.md
@@ -13,7 +13,7 @@ import { ScmIntegrations } from '@backstage/integration';
 import { ServiceRef } from '@backstage/backend-plugin-api';
 import { UrlReaderService } from '@backstage/backend-plugin-api';
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
 // @public (undocumented)
@@ -52,7 +52,7 @@ export type ReadTodosResult = {
   items: TodoItem[];
 };
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface RouterOptions {
   // (undocumented)
   todoService: TodoService;

diff --git a/workspaces/todo/plugins/todo-backend/src/service/router.ts b/workspaces/todo/plugins/todo-backend/src/service/router.ts
@@ -25,12 +25,18 @@ import {
 } from '../lib/utils';
 import { createOpenApiRouter } from '../schema/openapi.generated';
 
-/** @public */
+/**
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
+ *
+ * @public */
 export interface RouterOptions {
   todoService: TodoService;
 }
 
-/** @public */
+/**
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
+ *
+ * @public */
 export async function createRouter(
   options: RouterOptions,
 ): Promise<express.Router> {