diff --git a/packages/backend-defaults/api-report-health.md b/packages/backend-defaults/api-report-rootHealth.md similarity index 65% rename from packages/backend-defaults/api-report-health.md rename to packages/backend-defaults/api-report-rootHealth.md index 795bdaac78..ffa067605a 100644 --- a/packages/backend-defaults/api-report-health.md +++ b/packages/backend-defaults/api-report-rootHealth.md @@ -3,11 +3,14 @@ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/). ```ts -import { HealthService } from '@backstage/backend-plugin-api'; +import { RootHealthService } from '@backstage/backend-plugin-api'; import { ServiceFactory } from '@backstage/backend-plugin-api'; // @public (undocumented) -export const healthServiceFactory: () => ServiceFactory; +export const rootHealthServiceFactory: () => ServiceFactory< + RootHealthService, + 'root' +>; // (No @packageDocumentation comment for this package) ``` diff --git a/packages/backend-plugin-api/api-report.md b/packages/backend-plugin-api/api-report.md index ee5aecd63b..f527e366c0 100644 --- a/packages/backend-plugin-api/api-report.md +++ b/packages/backend-plugin-api/api-report.md @@ -194,7 +194,7 @@ export namespace coreServices { const rootConfig: ServiceRef; const database: ServiceRef; const discovery: ServiceRef; - const health: ServiceRef; + const health: ServiceRef; const httpAuth: ServiceRef; const httpRouter: ServiceRef; const lifecycle: ServiceRef; @@ -334,20 +334,6 @@ export type ExtensionPoint = { // @public @deprecated (undocumented) export type ExtensionPointConfig = CreateExtensionPointOptions; -// @public (undocumented) -export interface HealthService { - // (undocumented) - getLiveness(): Promise<{ - status: number; - payload?: any; - }>; - // (undocumented) - getReadiness(): Promise<{ - status: number; - payload?: any; - }>; -} - // @public export interface HttpAuthService { credentials( @@ -515,6 +501,18 @@ export function resolveSafeChildPath(base: string, path: string): string; // @public export interface RootConfigService extends Config {} +// @public (undocumented) +export interface RootHealthService { + getLiveness(): Promise<{ + status: number; + payload?: any; + }>; + getReadiness(): Promise<{ + status: number; + payload?: any; + }>; +} + // @public export interface RootHttpRouterService { use(path: string, handler: Handler): void;