From 21014532bf8e7cb648778fb2fcc8c98f5ca82cbf Mon Sep 17 00:00:00 2001
From: Andre Wanlin <67169551+awanlin@users.noreply.github.com>
Date: Sun, 1 Dec 2024 12:02:49 -0600
Subject: [PATCH] azure-sites - Deprecated legacy backend (#2042)

Signed-off-by: Andre Wanlin <awanlin@spotify.com>
---
 workspaces/azure-sites/.changeset/happy-cars-mix.md    |  5 +++++
 .../plugins/azure-sites-backend/report.api.md          |  4 ++--
 .../plugins/azure-sites-backend/src/service/router.ts  | 10 ++++++++--
 3 files changed, 15 insertions(+), 4 deletions(-)
 create mode 100644 workspaces/azure-sites/.changeset/happy-cars-mix.md

diff --git a/workspaces/azure-sites/.changeset/happy-cars-mix.md b/workspaces/azure-sites/.changeset/happy-cars-mix.md
new file mode 100644
index 000000000..478e29d22
--- /dev/null
+++ b/workspaces/azure-sites/.changeset/happy-cars-mix.md
@@ -0,0 +1,5 @@
+---
+'@backstage-community/plugin-azure-sites-backend': patch
+---
+
+Deprecated `createRouter` and its router options in favour of the new backend system.
diff --git a/workspaces/azure-sites/plugins/azure-sites-backend/report.api.md b/workspaces/azure-sites/plugins/azure-sites-backend/report.api.md
index b8012182a..f2cac78b6 100644
--- a/workspaces/azure-sites/plugins/azure-sites-backend/report.api.md
+++ b/workspaces/azure-sites/plugins/azure-sites-backend/report.api.md
@@ -58,10 +58,10 @@ export class AzureSitesConfig {
 const azureSitesPlugin: BackendFeature;
 export default azureSitesPlugin;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export function createRouter(options: RouterOptions): Promise<express.Router>;
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export interface RouterOptions {
   // (undocumented)
   auth?: AuthService;
diff --git a/workspaces/azure-sites/plugins/azure-sites-backend/src/service/router.ts b/workspaces/azure-sites/plugins/azure-sites-backend/src/service/router.ts
index 0e833ceac..02ff2a818 100644
--- a/workspaces/azure-sites/plugins/azure-sites-backend/src/service/router.ts
+++ b/workspaces/azure-sites/plugins/azure-sites-backend/src/service/router.ts
@@ -40,7 +40,10 @@ import {
   PermissionsService,
 } from '@backstage/backend-plugin-api';
 
-/** @public */
+/**
+ * @deprecated Please migrate to the new backend system as this will be removed in the future.
+ *
+ * @public */
 export interface RouterOptions {
   logger: LoggerService;
   azureSitesApi: AzureSitesApi;
@@ -51,7 +54,10 @@ export interface RouterOptions {
   httpAuth?: HttpAuthService;
 }
 
-/** @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> {