health service api report

Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
Vincenzo Scamporlino
2024-06-03 14:11:33 +02:00
parent 652da2e3e3
commit 78fdc5a39f
2 changed files with 14 additions and 0 deletions
@@ -194,6 +194,7 @@ export namespace coreServices {
const rootConfig: ServiceRef<RootConfigService, 'root'>;
const database: ServiceRef<DatabaseService, 'plugin'>;
const discovery: ServiceRef<DiscoveryService, 'plugin'>;
const health: ServiceRef<HealthService, 'root'>;
const httpAuth: ServiceRef<HttpAuthService, 'plugin'>;
const httpRouter: ServiceRef<HttpRouterService, 'plugin'>;
const lifecycle: ServiceRef<LifecycleService, 'plugin'>;
@@ -333,6 +334,9 @@ export type ExtensionPoint<T> = {
// @public @deprecated (undocumented)
export type ExtensionPointConfig = CreateExtensionPointOptions;
// @public (undocumented)
export interface HealthService {}
// @public
export interface HttpAuthService {
credentials<TAllowed extends keyof BackstagePrincipalTypes = 'unknown'>(
+10
View File
@@ -21,6 +21,7 @@ import { DiscoveryService } from '@backstage/backend-plugin-api';
import { EventsService } from '@backstage/plugin-events-node';
import { ExtendedHttpServer } from '@backstage/backend-app-api';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { HealthService } from '@backstage/backend-plugin-api';
import { HttpAuthService } from '@backstage/backend-plugin-api';
import { HttpRouterFactoryOptions } from '@backstage/backend-defaults/httpRouter';
import { HttpRouterService } from '@backstage/backend-plugin-api';
@@ -199,6 +200,15 @@ export namespace mockServices {
partialImpl?: Partial<EventsService> | undefined,
) => ServiceMock<EventsService>;
}
// (undocumented)
export namespace health {
const // (undocumented)
factory: () => ServiceFactory<HealthService, 'root'>;
const // (undocumented)
mock: (
partialImpl?: Partial<HealthService> | undefined,
) => ServiceMock<HealthService>;
}
export function httpAuth(options?: {
pluginId?: string;
defaultCredentials?: BackstageCredentials;