datacontract export markdown{/* AUTOGENERATED from datacontract --help: do not edit by hand; regenerate with update_command_docs.py */}
Export a data contract to Markdown.
datacontract export markdown [OPTIONS] [LOCATION]
| Argument | Default | Description |
|---|---|---|
[LOCATION] |
datacontract.yaml |
The location (url or path) of the data contract yaml. |
| Option | Default | Description |
|---|---|---|
--output |
— | File path where the exported data will be saved. If not provided, it will be printed to stdout. |
--server |
— | The server name to export. |
--schema-name |
all |
Which schema to export, e.g., orders, or all for all schemas (default). |
--json-schema |
— | The location (url or path) of the ODCS JSON Schema. |
--inline-references / --no-inline-references |
--inline-references |
Resolve external references (currently: authoritativeDefinitions[type in {definition, semantics}]) in the contract and inline the fetched content from the configured entropy-data host. |
--debug / --no-debug |
— | Enable debug logging |
datacontract export markdown datacontract.yaml --output datacontract.md
Guide: Export: Markdown.
