Brand Studio docs
Engineering manualSchema reference

Open Design Design-System Handoff

Declared schema: schemas/open-design-handoff.schema.json

Source: schemas/open-design-handoff.schema.json. This is the complete declaration, including nested definitions and constraints. Its presence is not evidence that a runtime producer or consumer validates against it.

All schemas · Data structures and lineage

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://brand-studio.local/schemas/open-design-handoff.schema.json",
  "title": "Open Design Design-System Handoff",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "handoff_id",
    "brand_slug",
    "target",
    "evidence_pack_path",
    "required_outputs",
    "design_md_requirements",
    "provenance_rules"
  ],
  "properties": {
    "handoff_id": {
      "type": "string"
    },
    "brand_slug": {
      "type": "string"
    },
    "target": {
      "const": "open_design_design_system"
    },
    "evidence_pack_path": {
      "type": "string"
    },
    "reference_manifest_path": {
      "type": "string"
    },
    "brand_mark_assets_path": {
      "type": "string"
    },
    "required_outputs": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "minItems": 8
    },
    "design_md_requirements": {
      "type": "object",
      "required": [
        "required_sections",
        "minimum_lines",
        "target_lines"
      ],
      "properties": {
        "required_sections": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "minItems": 9
        },
        "minimum_lines": {
          "type": "integer",
          "minimum": 100
        },
        "target_lines": {
          "type": "string"
        }
      }
    },
    "provenance_rules": {
      "type": "object",
      "required": [
        "must_label_confirmed_observed_inferred_estimated",
        "must_preserve_source_ids",
        "must_not_imply_brand_endorsement"
      ],
      "properties": {
        "must_label_confirmed_observed_inferred_estimated": {
          "type": "boolean"
        },
        "must_preserve_source_ids": {
          "type": "boolean"
        },
        "must_not_imply_brand_endorsement": {
          "type": "boolean"
        }
      }
    }
  }
}