schemas/cim_builder_to_ib_deck_qc.schema.json

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "investment-banking/schemas/cim_builder_to_ib_deck_qc.schema.json",
  "title": "cim_builder_to_ib_deck_qc",
  "description": "Canonical Investment Banking handoff contract from cim-builder to ib-deck-qc.",
  "type": "object",
  "required": [
    "contract_name"
  ],
  "properties": {
    "contract_name": {
      "const": "cim_builder_to_ib_deck_qc"
    }
  },
  "additionalProperties": true,
  "$defs": {
    "record": {
      "type": "object",
      "required": [
        "artifact_type",
        "artifact_version",
        "circulation_posture",
        "audience",
        "transaction_context",
        "last_updated",
        "page_plan",
        "source_log",
        "key_numbers_to_tie",
        "claim_register",
        "chart_and_visual_register",
        "financial_tie_outs",
        "style_profile_package",
        "style_change_log_package",
        "confidentiality_and_disclosure_flags",
        "open_items"
      ],
      "properties": {
        "artifact_type": {
          "type": [
            "string",
            "number",
            "boolean",
            "array",
            "object"
          ]
        },
        "artifact_version": {
          "type": [
            "string",
            "number",
            "boolean",
            "array",
            "object"
          ]
        },
        "circulation_posture": {
          "type": "string",
          "enum": [
            "working_draft",
            "senior_review_ready",
            "client_ready",
            "committee_ready",
            "not_circulable",
            "unknown",
            "not_provided"
          ]
        },
        "audience": {
          "type": [
            "string",
            "number",
            "boolean",
            "array",
            "object"
          ]
        },
        "transaction_context": {
          "type": [
            "string",
            "number",
            "boolean",
            "array",
            "object"
          ]
        },
        "last_updated": {
          "type": [
            "string",
            "number",
            "boolean",
            "array",
            "object"
          ]
        },
        "page_plan": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/generic_record"
          }
        },
        "source_log": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/source_log_record"
          }
        },
        "key_numbers_to_tie": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/key_number_to_tie"
          }
        },
        "claim_register": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/claim_record"
          }
        },
        "chart_and_visual_register": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/chart_visual_record"
          }
        },
        "financial_tie_outs": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/financial_tie_out"
          }
        },
        "style_profile_package": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/generic_record"
          }
        },
        "style_change_log_package": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/generic_record"
          }
        },
        "confidentiality_and_disclosure_flags": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/review_flag"
          }
        },
        "open_items": {
          "type": "array",
          "minItems": 1,
          "items": {
            "$ref": "handoff_common.schema.json#/$defs/open_item"
          }
        }
      },
      "additionalProperties": true
    }
  }
}