OData Metadata Workflows¶
CLI workflow¶
- Install
mdengine[odata]. - Run
md-odata --helpto list flags. - Provide input (OData CSDL metadata (XML/JSON), folders, ZIP archives, or $metadata URLs) and output path.
- Inspect generated Markdown and sidecar assets.
API workflow¶
- Install
mdengine[odata,api]. - Start uvicorn on
md_generator.odataAPI module (see Deployment). - Call sync endpoint for small payloads or job endpoint for large conversions.
- Poll job status and download artifact when complete.
Processing pipeline¶
flowchart TD
Start[Start] --> InputLoad[Load_input]
InputLoad --> Validate[Validate_options]
Validate --> Transform[Core_conversion]
Transform --> Render[Render_Markdown]
Render --> Package[Write_output_or_ZIP]
Package --> End[Complete]
Async job flow¶
Where job routes exist, background work uses in-process threads or domain job managers; results land in direct response.