Skip to main content

SchemaChange

pathstringrequired

Dotted field path; items[] for array elements, empty for the data itself.

Example: customer.email
pointerstringrequired
Example: /properties/customer/properties/email
kindstringrequired

Possible values: [field-added-required, field-added-optional, field-removed, field-became-required, field-became-optional, type-narrowed, type-widened, enum-values-removed, enum-values-added, enum-added, enum-removed, const-changed, constraint-tightened, constraint-relaxed, additional-properties-closed, additional-properties-opened, keyword-changed]

breakingbooleanrequired
messagestringrequired
Example: "customer.email" is now required
SchemaChange
{
  "path": "customer.email",
  "pointer": "/properties/customer/properties/email",
  "kind": "field-added-required",
  "breaking": true,
  "message": "\"customer.email\" is now required"
}