Export new types and update API report

Signed-off-by: lshwayne96 <lshwayne96@gmail.com>
This commit is contained in:
lshwayne96
2023-11-16 14:14:23 +08:00
committed by Fredrik Adelöw
parent c94ed08d16
commit 24ab4464e7
3 changed files with 27 additions and 3 deletions
+14 -1
View File
@@ -4,10 +4,12 @@
```ts
import { CatalogApi } from '@backstage/catalog-client';
import { CatalogPermissionRuleInput } from '@backstage/plugin-catalog-backend';
import { CatalogProcessor } from '@backstage/plugin-catalog-node';
import { Entity } from '@backstage/catalog-model';
import { EntityProvider } from '@backstage/plugin-catalog-node';
import { ExtensionPoint } from '@backstage/backend-plugin-api';
import { PermissionRule } from '@backstage/plugin-permission-node';
import { PermissionRuleParams } from '@backstage/plugin-permission-common';
import { PlaceholderResolver } from '@backstage/plugin-catalog-node';
import { ScmLocationAnalyzer } from '@backstage/plugin-catalog-node';
import { ServiceRef } from '@backstage/backend-plugin-api';
@@ -21,6 +23,11 @@ export interface CatalogAnalysisExtensionPoint {
// @alpha (undocumented)
export const catalogAnalysisExtensionPoint: ExtensionPoint<CatalogAnalysisExtensionPoint>;
// @alpha (undocumented)
export type CatalogPermissionRuleInput<
TParams extends PermissionRuleParams = PermissionRuleParams,
> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;
// @alpha (undocumented)
export interface CatalogProcessingExtensionPoint {
// (undocumented)
@@ -47,5 +54,11 @@ export const catalogProcessingExtensionPoint: ExtensionPoint<CatalogProcessingEx
// @alpha
export const catalogServiceRef: ServiceRef<CatalogApi, 'plugin'>;
// @alpha (undocumented)
export type EntitiesSearchFilter = {
key: string;
values?: string[];
};
// (No @packageDocumentation comment for this package)
```
+4
View File
@@ -19,3 +19,7 @@ export type { CatalogProcessingExtensionPoint } from './extensions';
export { catalogProcessingExtensionPoint } from './extensions';
export type { CatalogAnalysisExtensionPoint } from './extensions';
export { catalogAnalysisExtensionPoint } from './extensions';
export type {
EntitiesSearchFilter,
CatalogPermissionRuleInput,
} from './extensions';
+9 -2
View File
@@ -24,11 +24,18 @@ import {
ScmLocationAnalyzer,
} from '@backstage/plugin-catalog-node';
type EntitiesSearchFilter = {
/**
* @alpha
*/
export type EntitiesSearchFilter = {
key: string;
values?: string[];
};
type CatalogPermissionRuleInput<
/**
* @alpha
*/
export type CatalogPermissionRuleInput<
TParams extends PermissionRuleParams = PermissionRuleParams,
> = PermissionRule<Entity, EntitiesSearchFilter, 'catalog-entity', TParams>;