Skip to content

RenameResult

RenameResult

Result returned by in-place rename mutations: client.shape.rename and client.thing.rename. A rename patches the identity field directly and preserves the existing version history; no new version is created. The renamed: true discriminator distinguishes the success shape from a rejected request (which throws WarmHubError).

https://docs.warmhub.ai/data-modeling/naming-as-navigation/