Adds api report

Signed-off-by: sblausten <sam@roadie.io>
This commit is contained in:
sblausten
2022-06-30 12:24:50 +02:00
parent 156bb8ffba
commit 0b36b9cb0b
2 changed files with 23 additions and 1 deletions
+19 -1
View File
@@ -11,6 +11,7 @@ import { FactCheckerFactory } from '@backstage/plugin-tech-insights-node';
import { FactLifecycle } from '@backstage/plugin-tech-insights-node';
import { FactRetriever } from '@backstage/plugin-tech-insights-node';
import { FactRetrieverRegistration } from '@backstage/plugin-tech-insights-node';
import { FactSchema } from '@backstage/plugin-tech-insights-node';
import { Logger } from 'winston';
import { PluginDatabaseManager } from '@backstage/backend-common';
import { PluginEndpointDiscovery } from '@backstage/backend-common';
@@ -51,6 +52,22 @@ export type FactRetrieverRegistrationOptions = {
lifecycle?: FactLifecycle;
};
// @public (undocumented)
export interface FactRetrieverRegistry {
// (undocumented)
get(retrieverReference: string): FactRetrieverRegistration;
// (undocumented)
getSchemas(): FactSchema[];
// (undocumented)
listRegistrations(): FactRetrieverRegistration[];
// (undocumented)
listRetrievers(): FactRetriever[];
// (undocumented)
register(registration: FactRetrieverRegistration): void;
// (undocumented)
readonly retrievers: Map<string, FactRetrieverRegistration>;
}
// @public
export type PersistenceContext = {
techInsightsStore: TechInsightsStore;
@@ -91,7 +108,8 @@ export interface TechInsightsOptions<
// (undocumented)
discovery: PluginEndpointDiscovery;
factCheckerFactory?: FactCheckerFactory<CheckType, CheckResultType>;
factRetrievers: FactRetrieverRegistration[];
factRetrieverRegistry?: FactRetrieverRegistry;
factRetrievers?: FactRetrieverRegistration[];
// (undocumented)
logger: Logger;
// (undocumented)
@@ -21,6 +21,10 @@ import {
} from '@backstage/plugin-tech-insights-node';
import { ConflictError, NotFoundError } from '@backstage/errors';
/**
* @public
*
*/
export interface FactRetrieverRegistry {
readonly retrievers: Map<string, FactRetrieverRegistration>;
register(registration: FactRetrieverRegistration): void;