Brand Studio docs
Engineering manualSchema reference

Brand

Declared schema: schemas/brand.schema.json

Source: schemas/brand.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",
  "title": "Brand",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "id",
    "name",
    "status",
    "review_status",
    "source_url",
    "design_system_path",
    "content_system_path",
    "voice_path",
    "audiences",
    "offers",
    "ctas",
    "proof_points",
    "source_ids",
    "claim_ids",
    "review_requirements"
  ],
  "properties": {
    "id": {
      "type": "string",
      "pattern": "^[a-z0-9][a-z0-9_-]*$"
    },
    "name": {
      "type": "string",
      "minLength": 1
    },
    "status": {
      "type": "string",
      "enum": [
        "draft",
        "active",
        "archived"
      ]
    },
    "review_status": {
      "type": "string",
      "enum": [
        "draft",
        "needs_review",
        "approved",
        "rejected"
      ]
    },
    "source_url": {
      "type": "string",
      "minLength": 1
    },
    "created_at": {
      "type": "string"
    },
    "updated_at": {
      "type": "string"
    },
    "design_system_path": {
      "type": "string",
      "minLength": 1
    },
    "content_system_path": {
      "type": "string",
      "minLength": 1
    },
    "voice_path": {
      "type": "string",
      "minLength": 1
    },
    "brand_mark_assets_path": {
      "type": "string",
      "minLength": 1
    },
    "reference_manifest_path": {
      "type": "string",
      "minLength": 1
    },
    "brand_context_path": {
      "type": "string",
      "minLength": 1
    },
    "open_design_design_system_id": {
      "type": "string",
      "minLength": 1
    },
    "open_design_design_system_path": {
      "type": "string",
      "minLength": 1
    },
    "open_design_design_system_workspace_project_id": {
      "type": [
        "string",
        "null"
      ]
    },
    "design_system_status": {
      "type": "string",
      "enum": [
        "draft",
        "needs_review",
        "published",
        "approved",
        "rejected"
      ]
    },
    "design_system_package_status": {
      "type": "string",
      "enum": [
        "unknown",
        "too_thin",
        "needs_expansion",
        "rich_package_valid"
      ]
    },
    "audiences": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "label",
          "needs",
          "funnel_relevance"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "needs": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string",
              "minLength": 1
            }
          },
          "funnel_relevance": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string",
              "enum": [
                "awareness",
                "consideration",
                "conversion",
                "loyalty",
                "advocacy"
              ]
            }
          }
        }
      }
    },
    "offers": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "name",
          "incentive",
          "stage_fit"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "name": {
            "type": "string",
            "minLength": 1
          },
          "incentive": {
            "type": "string",
            "minLength": 1
          },
          "stage_fit": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string",
              "enum": [
                "awareness",
                "consideration",
                "conversion",
                "loyalty",
                "advocacy"
              ]
            }
          }
        }
      }
    },
    "ctas": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "label",
          "intent",
          "funnel_stage"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "label": {
            "type": "string",
            "minLength": 1
          },
          "intent": {
            "type": "string",
            "minLength": 1
          },
          "funnel_stage": {
            "type": "string",
            "enum": [
              "awareness",
              "consideration",
              "conversion",
              "loyalty",
              "advocacy"
            ]
          }
        }
      }
    },
    "proof_points": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "object",
        "additionalProperties": false,
        "required": [
          "id",
          "claim_id",
          "summary"
        ],
        "properties": {
          "id": {
            "type": "string",
            "minLength": 1
          },
          "claim_id": {
            "type": "string",
            "minLength": 1
          },
          "summary": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    },
    "source_ids": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "claim_ids": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "review_requirements": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "required_fields",
        "minimum_source_count",
        "claim_review_required"
      ],
      "properties": {
        "required_fields": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1
          }
        },
        "minimum_source_count": {
          "type": "integer",
          "minimum": 1
        },
        "claim_review_required": {
          "type": "boolean"
        }
      }
    }
  }
}