fix: escape pipe chars in markdown table cells for extra field values (fixes #832)

Author: barry0451

CHANGELOG.md

@@ -7,6 +7,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+### Fixed
+- Fix markdown export breaking table structure when extra field values contain pipe characters (#832)
+
 ## [0.11.6] - 2026-03-17
 
 ### Fixed

datacontract/export/markdown_exporter.py

@@ -366,11 +366,20 @@ def render_header(key: str) -> str:
 
         if isinstance(value_extra, list) and len(value_extra):
             if isinstance(value_extra[0], dict):
-                parts.append(array_of_dict_to_markdown(value_extra))
+                raw = array_of_dict_to_markdown(value_extra)
+                if is_in_table_cell:
+                    raw = raw.replace("|", "&#124;").replace("\n", "<br />")
+                parts.append(raw)
             elif isinstance(value_extra[0], str):
-                parts.append(array_to_markdown(value_extra))
+                raw = array_to_markdown(value_extra)
+                if is_in_table_cell:
+                    raw = raw.replace("\n", "<br />")
+                parts.append(raw)
         elif isinstance(value_extra, dict):
-            parts.append(dict_to_markdown(value_extra))
+            raw = dict_to_markdown(value_extra)
+            if is_in_table_cell:
+                raw = raw.replace("\n", "<br />")
+            parts.append(raw)
         else:
             parts.append(f"{str(value_extra)}{value_line_ending}")
 

tests/test_export_markdown.py

@@ -30,3 +30,31 @@ def test_to_markdown():
 
     with open("fixtures/markdown/export/expected.md", "r") as file:
         assert result == file.read()
+
+
+def test_pipe_chars_escaped_in_table_cells():
+    """Regression test for #832: pipe chars in extra field values should be escaped when inside table cells."""
+    from open_data_contract_standard.model import OpenDataContractStandard
+    import yaml
+
+    contract_yaml = """
+id: test-pipe-escape
+schema:
+  - name: orders
+    properties:
+      - name: order_id
+        logicalType: string
+        config:
+          mapping: "a | b | c"
+"""
+    contract = OpenDataContractStandard.model_validate(yaml.safe_load(contract_yaml))
+    result = to_markdown(contract)
+
+    # Find the table row for order_id
+    lines = [line for line in result.split("\n") if "order_id" in line and line.startswith("|")]
+    assert lines, "order_id table row not found"
+    row = lines[0]
+    # The row must have exactly 4 pipe chars as table delimiters (| col1 | col2 | col3 |)
+    assert row.count("|") == 4, (
+        f"Expected 4 pipe delimiters in row, got {row.count('|')}: {row!r}"
+    )