Brand Studio docs
Engineering manualSchema reference

Brand Studio brand-kit export manifest

Declared schema: schemas/brand-kit-export-manifest.schema.json

Source: schemas/brand-kit-export-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://mirrorfactory.com/schemas/brand-kit-export-manifest.schema.json",
  "title": "Brand Studio brand-kit export manifest",
  "description": "The customer-visible manifest embedded in a generated report ZIP beside result.json and brand-summary.md.",
  "type": "object",
  "required": [
    "schema_version",
    "run_id",
    "domain",
    "source_url",
    "generated_at",
    "capture_generated_at",
    "capture_route",
    "counts",
    "media_mirror",
    "files"
  ],
  "properties": {
    "schema_version": {
      "const": "brand-studio-all-rest-brand-kit/v1"
    },
    "run_id": {
      "type": "string",
      "minLength": 1
    },
    "domain": {
      "type": "string",
      "minLength": 1
    },
    "source_url": {
      "type": "string",
      "minLength": 1
    },
    "generated_at": {
      "type": "string",
      "minLength": 1
    },
    "capture_generated_at": {
      "type": "string",
      "minLength": 1
    },
    "capture_route": {
      "const": "all_rest"
    },
    "counts": {
      "type": "object",
      "required": [
        "ranked_colors",
        "declared_colors",
        "font_families",
        "logo_candidates",
        "logo_files",
        "icon_candidates",
        "icon_files",
        "socials",
        "pages"
      ],
      "properties": {
        "ranked_colors": {
          "$ref": "#/$defs/count"
        },
        "declared_colors": {
          "$ref": "#/$defs/count"
        },
        "font_families": {
          "$ref": "#/$defs/count"
        },
        "logo_candidates": {
          "$ref": "#/$defs/count"
        },
        "logo_files": {
          "$ref": "#/$defs/count"
        },
        "icon_candidates": {
          "$ref": "#/$defs/count"
        },
        "icon_files": {
          "$ref": "#/$defs/count"
        },
        "socials": {
          "$ref": "#/$defs/count"
        },
        "pages": {
          "$ref": "#/$defs/count"
        }
      },
      "additionalProperties": false
    },
    "media_mirror": {
      "description": "Null when no retention record is saved; otherwise a bounded summary of saved archive status. Missing counters remain null. Full asset references remain in result.json.",
      "anyOf": [
        {
          "type": "null"
        },
        {
          "$ref": "#/$defs/mediaMirrorSummary"
        }
      ]
    },
    "files": {
      "type": "array",
      "minItems": 5,
      "items": {
        "type": "object",
        "required": [
          "path",
          "bytes"
        ],
        "properties": {
          "path": {
            "type": "string",
            "minLength": 1
          },
          "bytes": {
            "type": "integer",
            "minimum": 0
          }
        },
        "additionalProperties": false
      }
    }
  },
  "$defs": {
    "count": {
      "type": "integer",
      "minimum": 0
    },
    "mediaMirrorSummary": {
      "type": "object",
      "required": [
        "files",
        "bytes",
        "skipped",
        "failures"
      ],
      "properties": {
        "files": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "bytes": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "skipped": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "failures": {
          "type": [
            "integer",
            "null"
          ],
          "minimum": 0
        },
        "status": {
          "type": "string",
          "minLength": 1
        },
        "reason": {
          "type": "string",
          "minLength": 1
        },
        "generated_at": {
          "type": "string",
          "minLength": 1
        }
      },
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}