Skip to content
UPG is in early alpha. The specification is still evolving and may change between versions.
Tools/Workspace & Portfolios/promote_to_canonical

promote_to_canonical

Promote an existing product node into the registry as its canonical, instead of authoring a fresh thinner one with `define_canonical_entity`. Copies the source node's description/tags/properties into a new registry node and (by default) registers the source as the canonical's first instance. Lets a team canonicalise the rich node they already curated.

Workspace & Portfoliosnon-atomic. Registry node add (+ optional instance_of edge) + flush.

Arguments

node_idstringrequired

The existing node (bare resolves against active product or source_product_id; or qualified {product_id}/{node_id}).

source_product_idstringoptional

Product ID owning a bare node_id.

canonical_idstringoptional

Optional explicit registry id; otherwise derived from type + title.

register_sourcebooleanoptional

Register the source node as the first instance (default true).

Returns

Shape
{ canonical, qualified_id, registered_source, edge?, portfolio_file }

See Also