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

update_canonical_entity

Edit a canonical registry entity in place (title, description, audience_role, tags, properties) WITHOUT disturbing the `instance_of` edges that point at it. The fix for a canonical seeded with a typo or placeholder: correct it via the API instead of hand-editing portfolio.upg. Properties are shallow-merged. At least one editable field is required.

Workspace & Portfoliosnon-atomic. In-place registry node patch + flush.

Arguments

canonical_idstringrequired

The registry entity id (bare, or registry/{id}).

titlestringoptional

New canonical name.

descriptionstringoptional

New description.

audience_rolestringoptional

Persona audience role (buyer/user/champion/influencer/partner); merged into properties.

tagsarrayoptional

Replacement tags.

propertiesobjectoptional

Properties to shallow-merge into the canonical.

Returns

Shape
{ canonical, qualified_id, instance_count, portfolio_file }

See Also