GenUiCatalogChangeKind enum

What changed between two versions of a catalog, seen from where it matters: the model that composes against it.

A catalog is a contract with something that cannot be recompiled. Renaming a property or dropping an enum value does not break the app — the app is where the change was made — it breaks the agent, whose prompt and few-shot examples still describe yesterday's components, and it breaks quietly, in production, one malformed message at a time.

Inheritance
Available extensions

Values

componentAdded → const GenUiCatalogChangeKind

A component the catalog did not have before.

const GenUiCatalogChangeKind(breaking: false)
componentRemoved → const GenUiCatalogChangeKind

A component that is gone. An agent that still asks for it gets nothing.

const GenUiCatalogChangeKind(breaking: true)
propertyAdded → const GenUiCatalogChangeKind

A property that can be left out.

const GenUiCatalogChangeKind(breaking: false)
propertyRemoved → const GenUiCatalogChangeKind

A property that is gone. A message that still carries it is rejected by a catalog that declares unevaluatedProperties: false.

const GenUiCatalogChangeKind(breaking: true)
propertyBecameRequired → const GenUiCatalogChangeKind

A property the model now has to send.

const GenUiCatalogChangeKind(breaking: true)
propertyBecameOptional → const GenUiCatalogChangeKind

A property the model no longer has to send.

const GenUiCatalogChangeKind(breaking: false)
propertyTypeChanged → const GenUiCatalogChangeKind

A property whose type changed under the same name, which is the change a model is least likely to survive: it keeps sending what it learned.

const GenUiCatalogChangeKind(breaking: true)
enumValueAdded → const GenUiCatalogChangeKind

A value the model may now send for an enumerated property.

const GenUiCatalogChangeKind(breaking: false)
enumValueRemoved → const GenUiCatalogChangeKind

A value the model may no longer send.

const GenUiCatalogChangeKind(breaking: true)
descriptionChanged → const GenUiCatalogChangeKind

The prose the model reads about a component or a property.

Not breaking, and not nothing: the description is the instruction. A reworded property changes what the model does with it.

const GenUiCatalogChangeKind(breaking: false)
catalogIdChanged → const GenUiCatalogChangeKind

The id a surface names when it is created against this catalog.

const GenUiCatalogChangeKind(breaking: true)

Properties

breaking → bool
Whether a message composed against the old catalog can still be wrong after this change.
final
hashCode → int
The hash code for this object.
no setterinherited
index → int
A numeric identifier for the enumerated value.
no setterinherited
name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.
no setter
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

values → const List<GenUiCatalogChangeKind>
A constant List of the values in this enum, in order of their declaration.