Brand Studio docs
Engineering manualSchema reference

Brand Intake Manifest

Declared schema: schemas/brand-intake-manifest.schema.json

Source: schemas/brand-intake-manifest.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/brand-intake-manifest.schema.json",
  "title": "Brand Intake Manifest",
  "type": "object",
  "additionalProperties": true,
  "required": [
    "manifest_id",
    "brand_id",
    "provider_statuses",
    "evidence_pack_path",
    "open_design_handoff_path",
    "design_system_package_status",
    "rich_package_valid",
    "campaign_creation_allowed",
    "source_ids",
    "claim_ids",
    "sources",
    "claims"
  ],
  "properties": {
    "schema_version": {
      "type": "string",
      "default": "brand-intake-manifest/v1"
    },
    "manifest_id": {
      "type": "string",
      "minLength": 1
    },
    "brand_id": {
      "type": "string",
      "minLength": 1
    },
    "brand_slug": {
      "type": "string",
      "minLength": 1
    },
    "generated_at": {
      "type": "string"
    },
    "intake_mode": {
      "type": "string",
      "enum": [
        "website",
        "no_website",
        "hybrid"
      ]
    },
    "provider_statuses": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "context_dev",
        "search_enrichment",
        "sitemap",
        "crawl",
        "screenshots",
        "services",
        "ctas",
        "claims",
        "reviews",
        "open_design_generation",
        "rich_package_validation"
      ],
      "properties": {
        "context_dev": {
          "$ref": "#/$defs/provider_status"
        },
        "search_enrichment": {
          "$ref": "#/$defs/provider_status"
        },
        "sitemap": {
          "$ref": "#/$defs/provider_status"
        },
        "crawl": {
          "$ref": "#/$defs/provider_status"
        },
        "screenshots": {
          "$ref": "#/$defs/provider_status"
        },
        "services": {
          "$ref": "#/$defs/provider_status"
        },
        "ctas": {
          "$ref": "#/$defs/provider_status"
        },
        "claims": {
          "$ref": "#/$defs/provider_status"
        },
        "reviews": {
          "$ref": "#/$defs/provider_status"
        },
        "open_design_generation": {
          "$ref": "#/$defs/provider_status"
        },
        "rich_package_validation": {
          "$ref": "#/$defs/provider_status"
        }
      }
    },
    "evidence_pack_path": {
      "type": "string",
      "minLength": 1
    },
    "open_design_handoff_path": {
      "type": "string",
      "minLength": 1
    },
    "reference_manifest_path": {
      "type": "string",
      "minLength": 1
    },
    "brand_mark_assets_path": {
      "type": "string",
      "minLength": 1
    },
    "open_design_design_system_id": {
      "type": "string",
      "minLength": 1
    },
    "open_design_design_system_path": {
      "type": "string",
      "minLength": 1
    },
    "design_system_package_status": {
      "type": "string",
      "enum": [
        "unknown",
        "too_thin",
        "needs_expansion",
        "rich_package_valid"
      ]
    },
    "rich_package_valid": {
      "type": "boolean"
    },
    "campaign_creation_allowed": {
      "type": "boolean"
    },
    "source_ids": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "claim_ids": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "sources": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/source"
      }
    },
    "claims": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/claim"
      }
    }
  },
  "$defs": {
    "provider_status_value": {
      "type": "string",
      "enum": [
        "complete",
        "completed",
        "passed",
        "valid",
        "available",
        "collected",
        "resolved",
        "ready",
        "not_applicable",
        "skipped",
        "partial",
        "blocked",
        "pending",
        "failed",
        "missing",
        "unknown"
      ]
    },
    "provider_status": {
      "oneOf": [
        {
          "$ref": "#/$defs/provider_status_value"
        },
        {
          "type": "object",
          "additionalProperties": true,
          "required": [
            "status"
          ],
          "properties": {
            "status": {
              "$ref": "#/$defs/provider_status_value"
            },
            "required": {
              "type": "boolean"
            },
            "provider": {
              "type": "string"
            },
            "evidence_path": {
              "type": "string"
            },
            "evidence_paths": {
              "type": "array",
              "items": {
                "type": "string"
              }
            },
            "blocker_reason": {
              "type": "string"
            },
            "next_action": {
              "type": "string"
            },
            "notes": {
              "type": "string"
            }
          }
        }
      ]
    },
    "source": {
      "type": "object",
      "additionalProperties": true,
      "anyOf": [
        {
          "required": [
            "id"
          ]
        },
        {
          "required": [
            "source_id"
          ]
        }
      ],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "source_id": {
          "type": "string",
          "minLength": 1
        },
        "type": {
          "type": "string"
        },
        "source_type": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "path": {
          "type": "string"
        },
        "url_or_path": {
          "type": "string"
        }
      }
    },
    "claim": {
      "type": "object",
      "additionalProperties": true,
      "anyOf": [
        {
          "required": [
            "id"
          ]
        },
        {
          "required": [
            "claim_id"
          ]
        }
      ],
      "required": [
        "source_ids"
      ],
      "properties": {
        "id": {
          "type": "string",
          "minLength": 1
        },
        "claim_id": {
          "type": "string",
          "minLength": 1
        },
        "claim": {
          "type": "string"
        },
        "source_ids": {
          "type": "array",
          "minItems": 1,
          "items": {
            "type": "string",
            "minLength": 1
          }
        }
      }
    }
  }
}