catalog-node: move model extension point back to alpha
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
This commit is contained in:
@@ -7,8 +7,7 @@ Promoted stable catalog extension points from alpha to main export. The followin
|
||||
- `catalogLocationsExtensionPoint` and `CatalogLocationsExtensionPoint`
|
||||
- `catalogProcessingExtensionPoint` and `CatalogProcessingExtensionPoint`
|
||||
- `catalogAnalysisExtensionPoint` and `CatalogAnalysisExtensionPoint`
|
||||
- `catalogModelExtensionPoint` and `CatalogModelExtensionPoint`
|
||||
|
||||
The old alpha exports for these extension points are now deprecated with `@deprecated` markers pointing to the new stable exports. Please update your imports from `@backstage/plugin-catalog-node/alpha` to `@backstage/plugin-catalog-node`.
|
||||
|
||||
Note: The `catalogPermissionExtensionPoint`, `CatalogPermissionExtensionPoint`, and `CatalogPermissionRuleInput` remain in alpha as they are deprecated in favor of `coreServices.permissionsRegistry`.
|
||||
Note: The `catalogModelExtensionPoint`, `catalogPermissionExtensionPoint`, and related types remain in alpha.
|
||||
|
||||
@@ -166,7 +166,7 @@ This is an example of relaxing the format rules of the `metadata.name` field:
|
||||
```ts
|
||||
import { createBackend } from '@backstage/backend-defaults';
|
||||
import { createBackendModule } from '@backstage/backend-plugin-api';
|
||||
import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node';
|
||||
import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
|
||||
|
||||
const myCatalogCustomizations = createBackendModule({
|
||||
pluginId: 'catalog',
|
||||
|
||||
@@ -166,7 +166,7 @@ This is an example of relaxing the format rules of the `metadata.name` field:
|
||||
```ts
|
||||
import { createBackend } from '@backstage/backend-defaults';
|
||||
import { createBackendModule } from '@backstage/backend-plugin-api';
|
||||
import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node';
|
||||
import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
|
||||
|
||||
const myCatalogCustomizations = createBackendModule({
|
||||
pluginId: 'catalog',
|
||||
|
||||
@@ -998,7 +998,7 @@ import {
|
||||
coreServices,
|
||||
createBackendModule,
|
||||
} from '@backstage/backend-plugin-api';
|
||||
import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node';
|
||||
import { catalogModelExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
|
||||
import { customEntityDataParser } from '../lib/customEntityDataParser';
|
||||
|
||||
export const catalogModuleCustomDataParser = createBackendModule({
|
||||
|
||||
@@ -31,11 +31,11 @@ import {
|
||||
catalogAnalysisExtensionPoint,
|
||||
CatalogLocationsExtensionPoint,
|
||||
catalogLocationsExtensionPoint,
|
||||
CatalogModelExtensionPoint,
|
||||
catalogModelExtensionPoint,
|
||||
catalogProcessingExtensionPoint,
|
||||
} from '@backstage/plugin-catalog-node';
|
||||
import {
|
||||
CatalogModelExtensionPoint,
|
||||
catalogModelExtensionPoint,
|
||||
CatalogPermissionExtensionPoint,
|
||||
catalogPermissionExtensionPoint,
|
||||
CatalogPermissionRuleInput,
|
||||
|
||||
@@ -6,8 +6,8 @@
|
||||
import { CatalogAnalysisExtensionPoint as CatalogAnalysisExtensionPoint_2 } from '@backstage/plugin-catalog-node';
|
||||
import { CatalogApi } from '@backstage/catalog-client';
|
||||
import { CatalogLocationsExtensionPoint as CatalogLocationsExtensionPoint_2 } from '@backstage/plugin-catalog-node';
|
||||
import { CatalogModelExtensionPoint as CatalogModelExtensionPoint_2 } from '@backstage/plugin-catalog-node';
|
||||
import { CatalogProcessingExtensionPoint as CatalogProcessingExtensionPoint_2 } from '@backstage/plugin-catalog-node';
|
||||
import { CatalogProcessorParser } from '@backstage/plugin-catalog-node';
|
||||
import { EntitiesSearchFilter } from '@backstage/plugin-catalog-node';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { ExtensionPoint } from '@backstage/backend-plugin-api';
|
||||
@@ -16,6 +16,7 @@ import { PermissionResourceRef } from '@backstage/plugin-permission-node';
|
||||
import { PermissionRule } from '@backstage/plugin-permission-node';
|
||||
import { PermissionRuleParams } from '@backstage/plugin-permission-common';
|
||||
import { ServiceRef } from '@backstage/backend-plugin-api';
|
||||
import { Validators } from '@backstage/catalog-model';
|
||||
|
||||
// @alpha @deprecated (undocumented)
|
||||
export type CatalogAnalysisExtensionPoint = CatalogAnalysisExtensionPoint_2;
|
||||
@@ -37,11 +38,14 @@ export type CatalogLocationsExtensionPoint = CatalogLocationsExtensionPoint_2;
|
||||
// @alpha @deprecated (undocumented)
|
||||
export const catalogLocationsExtensionPoint: ExtensionPoint<CatalogLocationsExtensionPoint_2>;
|
||||
|
||||
// @alpha @deprecated (undocumented)
|
||||
export type CatalogModelExtensionPoint = CatalogModelExtensionPoint_2;
|
||||
// @alpha (undocumented)
|
||||
export interface CatalogModelExtensionPoint {
|
||||
setEntityDataParser(parser: CatalogProcessorParser): void;
|
||||
setFieldValidators(validators: Partial<Validators>): void;
|
||||
}
|
||||
|
||||
// @alpha @deprecated (undocumented)
|
||||
export const catalogModelExtensionPoint: ExtensionPoint<CatalogModelExtensionPoint_2>;
|
||||
// @alpha (undocumented)
|
||||
export const catalogModelExtensionPoint: ExtensionPoint<CatalogModelExtensionPoint>;
|
||||
|
||||
// @alpha @deprecated (undocumented)
|
||||
export interface CatalogPermissionExtensionPoint {
|
||||
|
||||
@@ -10,7 +10,6 @@ import { AnalyzeLocationRequest } from '@backstage/plugin-catalog-common';
|
||||
import { AnalyzeLocationResponse } from '@backstage/plugin-catalog-common';
|
||||
import { BackstageCredentials } from '@backstage/backend-plugin-api';
|
||||
import { CatalogProcessor as CatalogProcessor_2 } from '@backstage/plugin-catalog-node';
|
||||
import { CatalogProcessorParser as CatalogProcessorParser_2 } from '@backstage/plugin-catalog-node';
|
||||
import { CompoundEntityRef } from '@backstage/catalog-model';
|
||||
import { Entity } from '@backstage/catalog-model';
|
||||
import { EntityProvider as EntityProvider_2 } from '@backstage/plugin-catalog-node';
|
||||
@@ -36,7 +35,6 @@ import { ScmLocationAnalyzer as ScmLocationAnalyzer_2 } from '@backstage/plugin-
|
||||
import { ServiceRef } from '@backstage/backend-plugin-api';
|
||||
import { StreamEntitiesRequest } from '@backstage/catalog-client';
|
||||
import { ValidateEntityResponse } from '@backstage/catalog-client';
|
||||
import { Validators } from '@backstage/catalog-model';
|
||||
|
||||
// @public (undocumented)
|
||||
export type AnalyzeOptions = {
|
||||
@@ -69,15 +67,6 @@ export interface CatalogLocationsExtensionPoint {
|
||||
// @public (undocumented)
|
||||
export const catalogLocationsExtensionPoint: ExtensionPoint<CatalogLocationsExtensionPoint>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CatalogModelExtensionPoint {
|
||||
setEntityDataParser(parser: CatalogProcessorParser_2): void;
|
||||
setFieldValidators(validators: Partial<Validators>): void;
|
||||
}
|
||||
|
||||
// @public (undocumented)
|
||||
export const catalogModelExtensionPoint: ExtensionPoint<CatalogModelExtensionPoint>;
|
||||
|
||||
// @public (undocumented)
|
||||
export interface CatalogProcessingExtensionPoint {
|
||||
addEntityProvider(
|
||||
|
||||
@@ -57,11 +57,9 @@ import {
|
||||
CatalogLocationsExtensionPoint as _CatalogLocationsExtensionPoint,
|
||||
CatalogProcessingExtensionPoint as _CatalogProcessingExtensionPoint,
|
||||
CatalogAnalysisExtensionPoint as _CatalogAnalysisExtensionPoint,
|
||||
CatalogModelExtensionPoint as _CatalogModelExtensionPoint,
|
||||
catalogLocationsExtensionPoint as _catalogLocationsExtensionPoint,
|
||||
catalogProcessingExtensionPoint as _catalogProcessingExtensionPoint,
|
||||
catalogAnalysisExtensionPoint as _catalogAnalysisExtensionPoint,
|
||||
catalogModelExtensionPoint as _catalogModelExtensionPoint,
|
||||
} from '@backstage/plugin-catalog-node';
|
||||
|
||||
/**
|
||||
@@ -100,18 +98,8 @@ export type CatalogAnalysisExtensionPoint = _CatalogAnalysisExtensionPoint;
|
||||
*/
|
||||
export const catalogAnalysisExtensionPoint = _catalogAnalysisExtensionPoint;
|
||||
|
||||
/**
|
||||
* @alpha
|
||||
* @deprecated Use {@link @backstage/plugin-catalog-node#CatalogModelExtensionPoint} instead
|
||||
*/
|
||||
export type CatalogModelExtensionPoint = _CatalogModelExtensionPoint;
|
||||
|
||||
/**
|
||||
* @alpha
|
||||
* @deprecated Use {@link @backstage/plugin-catalog-node#catalogModelExtensionPoint} instead
|
||||
*/
|
||||
export const catalogModelExtensionPoint = _catalogModelExtensionPoint;
|
||||
|
||||
export type { CatalogModelExtensionPoint } from './extensions';
|
||||
export { catalogModelExtensionPoint } from './extensions';
|
||||
export type { CatalogPermissionRuleInput } from './extensions';
|
||||
export type { CatalogPermissionExtensionPoint } from './extensions';
|
||||
export { catalogPermissionExtensionPoint } from './extensions';
|
||||
|
||||
@@ -97,7 +97,7 @@ export interface CatalogProcessingExtensionPoint {
|
||||
): void;
|
||||
}
|
||||
|
||||
/** @public */
|
||||
/** @alpha */
|
||||
export interface CatalogModelExtensionPoint {
|
||||
/**
|
||||
* Sets the validator function to use for one or more special fields of an
|
||||
@@ -158,7 +158,7 @@ export const catalogAnalysisExtensionPoint =
|
||||
id: 'catalog.analysis',
|
||||
});
|
||||
|
||||
/** @public */
|
||||
/** @alpha */
|
||||
export const catalogModelExtensionPoint =
|
||||
createExtensionPoint<CatalogModelExtensionPoint>({
|
||||
id: 'catalog.model',
|
||||
|
||||
@@ -32,11 +32,9 @@ export type {
|
||||
CatalogLocationsExtensionPoint,
|
||||
CatalogProcessingExtensionPoint,
|
||||
CatalogAnalysisExtensionPoint,
|
||||
CatalogModelExtensionPoint,
|
||||
} from './extensions';
|
||||
export {
|
||||
catalogLocationsExtensionPoint,
|
||||
catalogProcessingExtensionPoint,
|
||||
catalogAnalysisExtensionPoint,
|
||||
catalogModelExtensionPoint,
|
||||
} from './extensions';
|
||||
|
||||
Reference in New Issue
Block a user