SchemaCheck

The data schema of the version going live compared with the one callers use now. stored: both versions store a schema, and breaking changes refuse without allow_breaking. inferred: at least one has none, so schemas inferred from sample data were compared and the result is only a warning. none: nothing to compare.

sourcestringrequired

Possible values: [stored, inferred, none]

breaking object[]required

Array [

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

]

safe object[]required

Array [

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

]

SchemaCheck

{
  "source": "stored",
  "breaking": [
    {
      "path": "customer.email",
      "pointer": "/properties/customer/properties/email",
      "kind": "field-added-required",
      "breaking": true,
      "message": "\"customer.email\" is now required"
    }
  ],
  "safe": [
    {
      "path": "customer.email",
      "pointer": "/properties/customer/properties/email",
      "kind": "field-added-required",
      "breaking": true,
      "message": "\"customer.email\" is now required"
    }
  ]
}