Edit an interface definition

Breaking

Because interfaces expose API names, any change to an interface definition has the potential to break downstream applications and will necessarily break existing object implementations. When adding a new shared property or link type constraint to an interface, all implementations for object types that use the interface must be made in the same update to your Ontology. We also recommend updating your interface definitions and consumers at the same time.

If your downstream applications cannot be updated at the same time as interface changes, you can alternatively create a new version of the interface (as an extension or a standalone interface) and migrate to the new interface definition as soon as possible.

Add shared properties

From the Properties tab of the interface configuration, select Add shared properties and choose a shared property to add to the interface.

From the Link type constraints tab, select Create new link type constraint and add the necessary constraint metadata.

Remove shared properties

From the Properties tab, select ... next to the property you wish to remove from the interface.

Remove shared property from an interface.

From the Link type constraint tab, select ... next to the link type constraint you wish to edit or remove from the interface.

Remove or edit a link type constraint.

If editing a constraint, you can update the metadata as you would if you were creating the link type constraint for the first time.