health api reports
Signed-off-by: Vincenzo Scamporlino <vincenzos@spotify.com>
This commit is contained in:
+5
-2
@@ -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<HealthService, 'root'>;
|
||||
export const rootHealthServiceFactory: () => ServiceFactory<
|
||||
RootHealthService,
|
||||
'root'
|
||||
>;
|
||||
|
||||
// (No @packageDocumentation comment for this package)
|
||||
```
|
||||
@@ -194,7 +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 health: ServiceRef<RootHealthService, 'root'>;
|
||||
const httpAuth: ServiceRef<HttpAuthService, 'plugin'>;
|
||||
const httpRouter: ServiceRef<HttpRouterService, 'plugin'>;
|
||||
const lifecycle: ServiceRef<LifecycleService, 'plugin'>;
|
||||
@@ -334,20 +334,6 @@ export type ExtensionPoint<T> = {
|
||||
// @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<TAllowed extends keyof BackstagePrincipalTypes = 'unknown'>(
|
||||
@@ -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;
|
||||
|
||||
Reference in New Issue
Block a user