Skip to main content

datacontract breaking

Show compatibility impact between two data contracts.

datacontract breaking [OPTIONS] V1 V2
ArgumentDefaultDescription
V1requiredThe location (url, s3 url, or local path) of the source (before) data contract YAML.
V2requiredThe location (url, s3 url, or local path) of the target (after) data contract YAML.
OptionDefaultDescription
--perspectiveconsumerconsumer flags changes that lead to unexpected data for consumers, producer flags changes that can make data contract tests fail.
--inline-references / --no-inline-references--inline-referencesResolve authoritativeDefinitions of type definition, semantics or businessDefinition and inline them into the contract. Relative URLs and semantics IRIs are looked up on the ENTROPY_DATA_HOST (default https://api.entropy-data.com), other URLs are fetched directly, file references are read from disk. See https://docs.datacontract.com/semantics
--debug / --no-debug—Enable debug logging
datacontract breaking datacontract-v1.yaml datacontract-v2.yaml

Guide: Compare contract versions.