paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 31 Packages Projects Releases Wiki Activity

api reports

Browse Source 
Signed-off-by: Johan Haals <johan.haals@gmail.com>
This commit is contained in:
Johan Haals
2021-10-05 09:52:43 +02:00
parent 604987599e
commit a1594fb8ca
2 changed files with 47 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/catalog-client/api-report.md
+24
View File
@@ -38,6 +38,11 @@ export interface CatalogApi {
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
// (undocumented)
getEntityByName(
name: EntityName,
options?: CatalogRequestOptions,
@@ -88,6 +93,11 @@ export class CatalogClient implements CatalogApi {
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
// (undocumented)
getEntityByName(
compoundName: EntityName,
options?: CatalogRequestOptions,
@@ -133,6 +143,20 @@ export type CatalogEntitiesRequest = {
fields?: string[] | undefined;
};
// @public (undocumented)
export type CatalogEntityAncestorsRequest = {
entityRef: EntityName;
};
// @public (undocumented)
export type CatalogEntityAncestorsResponse = {
root: EntityName;
items: {
entity: Entity;
parents: EntityName[];
}[];
};
// @public (undocumented)
export type CatalogListResponse<T> = {
items: T[];
plugins/catalog/api-report.md
+23 -3
View File
@@ -7,10 +7,13 @@
import { AddLocationRequest } from '@backstage/catalog-client';
import { AddLocationResponse } from '@backstage/catalog-client';
import { ApiHolder } from '@backstage/core-plugin-api';
import { BackstagePlugin } from '@backstage/core-plugin-api';
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogClient } from '@backstage/catalog-client';
import { CatalogEntitiesRequest } from '@backstage/catalog-client';
import { CatalogEntityAncestorsRequest } from '@backstage/catalog-client';
import { CatalogEntityAncestorsResponse } from '@backstage/catalog-client';
import { CatalogListResponse } from '@backstage/catalog-client';
import { CatalogRequestOptions } from '@backstage/catalog-client';
import { Entity } from '@backstage/catalog-model';
@@ -68,6 +71,11 @@ export class CatalogClientWrapper implements CatalogApi {
options?: CatalogRequestOptions,
): Promise<CatalogListResponse<Entity>>;
// (undocumented)
getEntityAncestors(
request: CatalogEntityAncestorsRequest,
options?: CatalogRequestOptions,
): Promise<CatalogEntityAncestorsResponse>;
// (undocumented)
getEntityByName(
compoundName: EntityName,
options?: CatalogRequestOptions,
@@ -346,7 +354,7 @@ export const EntityPageLayout: {
// Warning: (ae-missing-release-tag) "EntityProcessingErrorsPanel" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public
export const EntityProcessingErrorsPanel: () => JSX.Element;
export const EntityProcessingErrorsPanel: () => JSX.Element | null;
// Warning: (ae-missing-release-tag) "EntitySwitch" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
@@ -354,7 +362,14 @@ export const EntityProcessingErrorsPanel: () => JSX.Element;
export const EntitySwitch: {
({ children }: PropsWithChildren<{}>): JSX.Element | null;
Case: (_: {
if?: ((entity: Entity) => boolean) | undefined;
if?:
| ((
entity: Entity,
context: {
apis: ApiHolder;
},
) => boolean | Promise<boolean>)
| undefined;
children: ReactNode;
}) => null;
};
@@ -382,7 +397,12 @@ export const FilteredEntityLayout: ({
// Warning: (ae-missing-release-tag) "hasCatalogProcessingErrors" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export const hasCatalogProcessingErrors: (entity: Entity) => boolean;
export const hasCatalogProcessingErrors: (
entity: Entity,
context: {
apis: ApiHolder;
},
) => Promise<boolean>;
// Warning: (ae-missing-release-tag) "isComponentType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//