Skip to main content
Version: Next

EntityProviderMutation

Home > @backstage/plugin-catalog-node > EntityProviderMutation

A 'full' mutation replaces all existing entities created by this entity provider with new ones. A 'delta' mutation can both add and remove entities provided by this provider. Previously provided entities from a 'full' mutation are not removed.

Signature:

export type EntityProviderMutation = {
type: 'full';
entities: DeferredEntity[];
} | {
type: 'delta';
added: DeferredEntity[];
removed: (DeferredEntity | {
entityRef: string;
locationKey?: string;
})[];
};

References: DeferredEntity