add api-reports

Signed-off-by: Kiss Miklos <miklos@roadie.io>
This commit is contained in:
Kiss Miklos
2022-10-05 14:09:22 +02:00
parent 5e8c2682fe
commit 148d33fa85
3 changed files with 43 additions and 36 deletions
+3 -36
View File
@@ -5,6 +5,9 @@
```ts
/// <reference types="node" />
import { AnalyzeLocationExistingEntity } from '@backstage/plugin-catalog-common';
import { AnalyzeLocationRequest } from '@backstage/plugin-catalog-common';
import { AnalyzeLocationResponse } from '@backstage/plugin-catalog-common';
import { BackendFeature } from '@backstage/backend-plugin-api';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogEntityDocument } from '@backstage/plugin-catalog-common';
@@ -51,42 +54,6 @@ import { TokenManager } from '@backstage/backend-common';
import { UrlReader } from '@backstage/backend-common';
import { Validators } from '@backstage/catalog-model';
// @public (undocumented)
export type AnalyzeLocationEntityField = {
field: string;
state:
| 'analysisSuggestedValue'
| 'analysisSuggestedNoValue'
| 'needsUserInput';
value: string | null;
description: string;
};
// @public
export type AnalyzeLocationExistingEntity = {
location: LocationSpec;
isRegistered: boolean;
entity: Entity;
};
// @public
export type AnalyzeLocationGenerateEntity = {
entity: RecursivePartial<Entity>;
fields: AnalyzeLocationEntityField[];
};
// @public (undocumented)
export type AnalyzeLocationRequest = {
location: LocationSpec;
catalogFilename?: string;
};
// @public (undocumented)
export type AnalyzeLocationResponse = {
existingEntityFiles: AnalyzeLocationExistingEntity[];
generateEntities: AnalyzeLocationGenerateEntity[];
};
// @public (undocumented)
export type AnalyzeOptions = {
url: string;
+38
View File
@@ -4,9 +4,47 @@
```ts
import { BasicPermission } from '@backstage/plugin-permission-common';
import { Entity } from '@backstage/catalog-model';
import { IndexableDocument } from '@backstage/plugin-search-common';
import { LocationSpec } from '@backstage/plugin-catalog-node';
import { ResourcePermission } from '@backstage/plugin-permission-common';
// @public (undocumented)
export type AnalyzeLocationEntityField = {
field: string;
state:
| 'analysisSuggestedValue'
| 'analysisSuggestedNoValue'
| 'needsUserInput';
value: string | null;
description: string;
};
// @public
export type AnalyzeLocationExistingEntity = {
location: LocationSpec;
isRegistered: boolean;
entity: Entity;
};
// @public
export type AnalyzeLocationGenerateEntity = {
entity: RecursivePartial<Entity>;
fields: AnalyzeLocationEntityField[];
};
// @public (undocumented)
export type AnalyzeLocationRequest = {
location: LocationSpec;
catalogFilename?: string;
};
// @public (undocumented)
export type AnalyzeLocationResponse = {
existingEntityFiles: AnalyzeLocationExistingEntity[];
generateEntities: AnalyzeLocationGenerateEntity[];
};
// @alpha
export const catalogEntityCreatePermission: BasicPermission;
@@ -18,4 +18,6 @@ export type {
AnalyzeLocationResponse,
AnalyzeLocationRequest,
AnalyzeLocationExistingEntity,
AnalyzeLocationGenerateEntity,
AnalyzeLocationEntityField,
} from './LocationAnalyzer';