Brand Studio docs
Engineering manualSchema reference

Brand Studio results surface specification

Declared schema: schemas/brand-studio-results-surface-spec.schema.json

Source: schemas/brand-studio-results-surface-spec.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.mirrorfactory.ai/schemas/brand-studio-results-surface-spec.schema.json",
  "title": "Brand Studio results surface specification",
  "type": "object",
  "additionalProperties": false,
  "required": [
    "schema_version",
    "updated_at",
    "status",
    "title",
    "purpose",
    "authority",
    "section_order",
    "sections",
    "social_contract",
    "delivery_outputs",
    "quality_gates",
    "featured_example_contract"
  ],
  "properties": {
    "schema_version": {
      "const": "brand-studio-results-surface-spec/v1"
    },
    "updated_at": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "enum": [
        "proposed",
        "active",
        "approved",
        "archived"
      ]
    },
    "title": {
      "type": "string",
      "minLength": 1
    },
    "purpose": {
      "type": "string",
      "minLength": 1
    },
    "authority": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "canonical_collection",
        "canonical_client_package",
        "canonical_social_record",
        "canonical_social_bundle",
        "projection_rule"
      ],
      "properties": {
        "canonical_collection": {
          "type": "string",
          "minLength": 1
        },
        "canonical_client_package": {
          "type": "string",
          "minLength": 1
        },
        "canonical_social_record": {
          "type": "string",
          "minLength": 1
        },
        "canonical_social_bundle": {
          "type": "string",
          "minLength": 1
        },
        "projection_rule": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "section_order": {
      "type": "array",
      "minItems": 1,
      "uniqueItems": true,
      "items": {
        "type": "string",
        "pattern": "^[a-z0-9_]+$"
      }
    },
    "sections": {
      "type": "array",
      "minItems": 1,
      "items": {
        "$ref": "#/$defs/section"
      }
    },
    "social_contract": {
      "$ref": "#/$defs/socialContract"
    },
    "delivery_outputs": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "run_layer",
        "normalized_client_layer",
        "human_projections"
      ],
      "properties": {
        "run_layer": {
          "$ref": "#/$defs/stringArray"
        },
        "normalized_client_layer": {
          "$ref": "#/$defs/stringArray"
        },
        "human_projections": {
          "$ref": "#/$defs/stringArray"
        }
      }
    },
    "quality_gates": {
      "$ref": "#/$defs/stringArray"
    },
    "featured_example_contract": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "registry",
        "required_state",
        "resolver",
        "rule"
      ],
      "properties": {
        "registry": {
          "type": "string",
          "minLength": 1
        },
        "required_state": {
          "const": "published_local_example"
        },
        "resolver": {
          "type": "string",
          "minLength": 1
        },
        "rule": {
          "type": "string",
          "minLength": 1
        }
      }
    }
  },
  "$defs": {
    "stringArray": {
      "type": "array",
      "minItems": 1,
      "items": {
        "type": "string",
        "minLength": 1
      }
    },
    "module": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "contains",
        "rule"
      ],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^[a-z0-9_]+$"
        },
        "contains": {
          "$ref": "#/$defs/stringArray"
        },
        "rule": {
          "type": "string",
          "minLength": 1
        }
      }
    },
    "section": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "label",
        "component",
        "purpose",
        "input_paths",
        "reader_outcome",
        "modules",
        "allowed_claims",
        "prohibited_claims",
        "acceptance"
      ],
      "properties": {
        "id": {
          "type": "string",
          "pattern": "^[a-z0-9_]+$"
        },
        "label": {
          "type": "string",
          "minLength": 1
        },
        "component": {
          "type": "string",
          "minLength": 1
        },
        "purpose": {
          "type": "string",
          "minLength": 1
        },
        "input_paths": {
          "$ref": "#/$defs/stringArray"
        },
        "reader_outcome": {
          "type": "string",
          "minLength": 1
        },
        "modules": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "#/$defs/module"
          }
        },
        "allowed_claims": {
          "$ref": "#/$defs/stringArray"
        },
        "prohibited_claims": {
          "$ref": "#/$defs/stringArray"
        },
        "acceptance": {
          "$ref": "#/$defs/stringArray"
        }
      }
    },
    "platform": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "id",
        "content_types",
        "profile_scope",
        "special_rules"
      ],
      "properties": {
        "id": {
          "enum": [
            "linkedin",
            "facebook",
            "instagram",
            "x",
            "tiktok",
            "youtube"
          ]
        },
        "content_types": {
          "$ref": "#/$defs/stringArray"
        },
        "profile_scope": {
          "$ref": "#/$defs/stringArray"
        },
        "special_rules": {
          "$ref": "#/$defs/stringArray"
        }
      }
    },
    "socialContract": {
      "type": "object",
      "additionalProperties": false,
      "required": [
        "record_schema",
        "bundle_schema",
        "client_projection_schema",
        "required_record_groups",
        "platforms",
        "completion_levels",
        "completion_rule"
      ],
      "properties": {
        "record_schema": {
          "type": "string",
          "minLength": 1
        },
        "bundle_schema": {
          "type": "string",
          "minLength": 1
        },
        "client_projection_schema": {
          "type": "string",
          "minLength": 1
        },
        "required_record_groups": {
          "$ref": "#/$defs/stringArray"
        },
        "platforms": {
          "type": "array",
          "minItems": 6,
          "maxItems": 6,
          "items": {
            "$ref": "#/$defs/platform"
          }
        },
        "completion_levels": {
          "$ref": "#/$defs/stringArray"
        },
        "completion_rule": {
          "type": "string",
          "minLength": 1
        }
      }
    }
  }
}