chore(api-report): update api report for tech-inisghts

Signed-off-by: Fernando.Teixeira <fernando.Teixeira@traderev.com>
This commit is contained in:
Fernando.Teixeira
2023-01-25 15:03:16 -05:00
parent f44199533a
commit 9d59c101c8
4 changed files with 24 additions and 18 deletions
+1 -1
View File
@@ -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';
@@ -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<string, any>;
};
};
// (No @packageDocumentation comment for this package)
```
+1 -17
View File
@@ -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<string, any>;
};
};
// @public
export type FactSchemaDefinition = Omit<FactRetriever, 'handler'>;
+5
View File
@@ -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<InsightFacts>;
// (undocumented)
getFactSchemas(): Promise<FactSchema[]>;
// (undocumented)
runBulkChecks(
entities: CompoundEntityRef[],
checks?: Check[],
@@ -102,6 +105,8 @@ export class TechInsightsClient implements TechInsightsApi {
// (undocumented)
getFacts(entity: CompoundEntityRef, facts: string[]): Promise<InsightFacts>;
// (undocumented)
getFactSchemas(): Promise<FactSchema[]>;
// (undocumented)
runBulkChecks(
entities: CompoundEntityRef[],
checks?: Check[],