From da5dd9361827df0fcb01be2bd720338db227771a Mon Sep 17 00:00:00 2001 From: Johan Haals Date: Mon, 2 Sep 2024 15:12:21 +0200 Subject: [PATCH] backend-defaults: deprecate createLifecycleMiddleware Reduce API surface by deprecating export with no external usage. Fixes #26359 Signed-off-by: Johan Haals --- packages/backend-defaults/api-report-httpRouter.md | 2 +- .../src/entrypoints/httpRouter/createLifecycleMiddleware.ts | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/packages/backend-defaults/api-report-httpRouter.md b/packages/backend-defaults/api-report-httpRouter.md index dc612377ae..bc5f069559 100644 --- a/packages/backend-defaults/api-report-httpRouter.md +++ b/packages/backend-defaults/api-report-httpRouter.md @@ -9,7 +9,7 @@ import { LifecycleService } from '@backstage/backend-plugin-api'; import { RequestHandler } from 'express'; import { ServiceFactory } from '@backstage/backend-plugin-api'; -// @public +// @public @deprecated export function createLifecycleMiddleware( options: LifecycleMiddlewareOptions, ): RequestHandler; diff --git a/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts b/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts index 3f8ee3ea69..2a18f5046e 100644 --- a/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts +++ b/packages/backend-defaults/src/entrypoints/httpRouter/createLifecycleMiddleware.ts @@ -48,6 +48,8 @@ export interface LifecycleMiddlewareOptions { * {@link @backstage/errors#ServiceUnavailableError}. * * @public + * @deprecated This function export will be removed in a future release. + * If rely on this function then please reach out to the Backstage maintainers. */ export function createLifecycleMiddleware( options: LifecycleMiddlewareOptions,