End-to-End Example: Builder Showcase

This page covers all major builders in one compact document.

Input Markdown

# RUNBOOK: Builder Showcase

## 1. META

- Service: Fraud API

## 3. EVENTS

### Step A

**Classification:** TIMELESS

**STATUS:** ACTIVE

Schema

import { md } from '@markschema/mdshape'

const schema = md.document({
  title: md.heading(1),
  meta: md.section('1. META').fields({ Service: md.string() }),
  events: md
    .section('3. EVENTS')
    .subsections(3)
    .each(
      md.object({
        title: md.headingText(),
        classification: md.match.label('Classification').value(md.enum(['TIME_BOUND', 'TIMELESS', 'HYBRID'])),
        status: md.match.label('STATUS').value(md.union([md.literal('ACTIVE'), md.number()])),
      }),
    )
    .min(1),
})

Result

Success

{
  "success": true,
  "data": {
    "title": "RUNBOOK: Builder Showcase",
    "meta": {
      "Service": "Fraud API"
    },
    "events": [
      {
        "title": "Step A",
        "classification": "TIMELESS",
        "status": "ACTIVE"
      }
    ]
  }
}

Error

Failure trigger: The input violates one or more constraints declared in the schema; use issues[].path and issues[].code to locate the exact failing node.

{
  "success": false,
  "error": {
    "issues": [
      {
        "code": "missing_heading",
        "message": "Missing heading with depth 1",
        "path": [
          "title"
        ],
        "line": 1,
        "position": {
          "start": {
            "line": 1,
            "column": 1
          }
        }
      }
    ]
  }
}