Skip to main content

datacontract lint

Validate that the datacontract.yaml is correctly formatted.

datacontract lint [OPTIONS] [LOCATION]
ArgumentDefaultDescription
[LOCATION]datacontract.yamlThe location (url, s3 url, or local path) of the data contract yaml.
OptionDefaultDescription
--json-schemaThe location (url or path) of the ODCS JSON Schema
--outputSpecify the file path where the test results should be written to (e.g., './test-results/TEST-datacontract.xml'). If no path is provided, the output will be printed to stdout.
--output-formatThe target format for the test results. Accepted values: json, junit.
--all-errorsoffReport all JSON Schema validation errors instead of stopping after the first one.
--inline-references / --no-inline-references--inline-referencesResolve external references (currently: authoritativeDefinitions[type in {definition, semantics}]) in the contract and inline the fetched content from the configured entropy-data host.
--debug / --no-debugEnable debug logging
datacontract lint datacontract.yaml

Guide: Open Data Contract Standard.