diff --git a/plugins/tech-insights-backend/api-report.md b/plugins/tech-insights-backend/api-report.md index a757f0d67c..4b6e5b34dc 100644 --- a/plugins/tech-insights-backend/api-report.md +++ b/plugins/tech-insights-backend/api-report.md @@ -12,7 +12,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 { FactSchema } from '@backstage/plugin-tech-insights-common'; import { HumanDuration } from '@backstage/types'; import { Logger } from 'winston'; import { PluginDatabaseManager } from '@backstage/backend-common'; diff --git a/plugins/tech-insights-common/api-report.md b/plugins/tech-insights-common/api-report.md index 0236c0619a..51ef13a013 100644 --- a/plugins/tech-insights-common/api-report.md +++ b/plugins/tech-insights-common/api-report.md @@ -47,5 +47,22 @@ export type FactResponse = { }; }; +// @public +export type FactSchema = { + [name: string]: { + type: + | 'integer' + | 'float' + | 'string' + | 'boolean' + | 'datetime' + | 'set' + | 'object'; + description: string; + since?: string; + metadata?: Record; + }; +}; + // (No @packageDocumentation comment for this package) ``` diff --git a/plugins/tech-insights-node/api-report.md b/plugins/tech-insights-node/api-report.md index 47e76b07ce..dbb8a8b674 100644 --- a/plugins/tech-insights-node/api-report.md +++ b/plugins/tech-insights-node/api-report.md @@ -8,6 +8,7 @@ import { Config } from '@backstage/config'; import { DateTime } from 'luxon'; import { Duration } from 'luxon'; import { DurationLike } from 'luxon'; +import { FactSchema } from '@backstage/plugin-tech-insights-common'; import { HumanDuration } from '@backstage/types'; import { JsonValue } from '@backstage/types'; import { Logger } from 'winston'; @@ -78,23 +79,6 @@ export type FactRetrieverRegistration = { initialDelay?: Duration | HumanDuration; }; -// @public -export type FactSchema = { - [name: string]: { - type: - | 'integer' - | 'float' - | 'string' - | 'boolean' - | 'datetime' - | 'set' - | 'object'; - description: string; - since?: string; - metadata?: Record; - }; -}; - // @public export type FactSchemaDefinition = Omit; diff --git a/plugins/tech-insights/api-report.md b/plugins/tech-insights/api-report.md index 2d25d6d39d..d7ae337196 100644 --- a/plugins/tech-insights/api-report.md +++ b/plugins/tech-insights/api-report.md @@ -11,6 +11,7 @@ import { BulkCheckResponse } from '@backstage/plugin-tech-insights-common'; import { CheckResult } from '@backstage/plugin-tech-insights-common'; import { CompoundEntityRef } from '@backstage/catalog-model'; import { DiscoveryApi } from '@backstage/core-plugin-api'; +import { FactSchema } from '@backstage/plugin-tech-insights-common'; import { IdentityApi } from '@backstage/core-plugin-api'; import { JsonValue } from '@backstage/types'; import { default as React_2 } from 'react'; @@ -74,6 +75,8 @@ export interface TechInsightsApi { // (undocumented) getFacts(entity: CompoundEntityRef, facts: string[]): Promise; // (undocumented) + getFactSchemas(): Promise; + // (undocumented) runBulkChecks( entities: CompoundEntityRef[], checks?: Check[], @@ -102,6 +105,8 @@ export class TechInsightsClient implements TechInsightsApi { // (undocumented) getFacts(entity: CompoundEntityRef, facts: string[]): Promise; // (undocumented) + getFactSchemas(): Promise; + // (undocumented) runBulkChecks( entities: CompoundEntityRef[], checks?: Check[],