dca_config.schema.json

{
  "title": "Configuration for individual DCCs in mtDCA",
  "description": "Configuration options for a specific DCC in mtDCA",
  "required": [ "dcc", "dca", "schematic" ],
  "additionalProperties": false,
  "properties": {
    "dcc": {
      "description": "DCC parameters",
      "type": "object",
      "required": [
        "name",
        "synapse_asset_view",
        "data_model_url",
        "data_model_info",
        "template_menu_config_file",
        "logo_location",
        "logo_link",
        "dcc_help_link",
        "portal_help_link"
      ],
      "properties": {
        "name": {
          "description": "Name of the DCC",
          "type": "string"
        },
        "synapse_asset_view": {
          "description": "Synapse ID of the DCC's main asset view",
          "type": "string",
          "pattern": "^syn[0-9]+$"
        },
        "data_model_url": {
          "description": "URL to the DCC's data model",
          "type": "string",
          "format": "uri-reference"
        },
        "data_model_info": {
          "description": "URL to release notes about the data model",
          "type": "string",
          "format": "uri-reference"
        },
        "template_menu_config_file": {
          "description": "Path to the template dropdown menu config",
          "type": "string"
        },
        "logo_location": {
          "description": "URL to the DCC's logo",
          "type": "string"
        },
        "logo_link": {
          "description": "Link for the DCC",
          "type": "string",
          "format": "uri-reference"
        },
        "dcc_help_link": {
          "description": "URL DCC users can seek help",
          "type": "string"
        },
        "portal_help_link": {
          "description": "URL for portal information",
          "type": "string"
        }
      }
    },
    "dca": {
      "description": "DCA configuration options",
      "type": "object",
      "required": [
        "use_compliance_dashboard",
        "primary_col",
        "secondary_col",
        "sidebar_col"
      ],
      "properties": {
        "use_compliance_dashboard": {
          "description": "Display the compliance dashboard. Unavaible at the moment",
          "type": "boolean"
        },
        "primary_col": {
          "description": "center header color hex code",
          "type": "string",
          "pattern": "^#[0-9]+"
        },
        "secondary_col": {
          "description": "right header color hex code",
          "type": "string",
          "pattern": "^#[0-9]+"
        },
        "sidebar_col": {
          "description": "left header color hex code",
          "type": "string",
          "pattern": "^#[0-9]+"
        }
      }
    },
    "schematic": {
      "description": "Schematic configuration options",
      "type": "object",
      "required": [
        "global",
        "manifest_generate",
        "model_validate",
        "model_submit"
      ],
      "additionalProperties": false,
      "properties": {
        "global": {
          "description": "Parameters common to many schematic commands",
          "type": "object",
          "required": [ "data_model_labels" ],
          "properties": {
            "data_model_labels": {
              "description": "Source for labels of the data model",
              "type": "string",
              "enum": [ "class_label", "display_label" ]
            }
          }
        },
        "manifest_generate": {
          "description": "Parameters to pass to Schematic manifest generate",
          "type": "object",
          "required": [ "output_format", "use_annotations" ],
          "additionalProperties": false,
          "properties": {
            "output_format": {
              "description": "Output type for downloaded manifests. excel or google_sheet",
              "type": "string",
              "enum": [ "excel", "google_sheet" ]
            },
            "use_annotations": {
              "description": "Schematic manifest get option",
              "type": "boolean"
            }
          }
        },
        "model_validate": {
          "description": "Parameteres to pass to Schematic model validate",
          "type": "object",
          "required": [ 
            "restrict_rules",
            "enable_cross_manifest_validation"
          ],
          "additionalProperties": false,
          "properties": {
            "restrict_rules": {
              "description": "Schematic model validate option",
              "type": "boolean"
            },
            "enable_cross_manifest_validation": {
              "description": "Use cross manifest validation",
              "type": "boolean"
            }
          }
        },
        "model_submit": {
          "description": "Parameters to pass Schematic model submit",
          "type": "object",
          "required": [
            "table_manipulation",
            "manifest_record_type",
            "hide_blanks",
            "annotation_keys",
            "table_column_names",
            "file_annotations_upload"
          ],
          "additionalProperties": false,              
          "properties": {
            "annotation_keys": {
              "description": "Schematic model submit option",
              "type": "string",
              "enum": [ "class_label", "display_label" ]
            },
            "table_column_names": {
              "description": "Schematic model submit option",
              "type": "string",
              "enum": [ "class_label", "display_label", "display_name" ]
            },
            "table_manipulation": {
              "description": "Schematic model submit option",
              "type": "string",
              "enum": [ "replace", "upsert" ]
            },
            "manifest_record_type": {
              "description": "Schematic model submit option",
              "type": "string",
              "enum": [ "file_only", "table_and_file", "table_file_and_entities", "file_and_entities" ]
            },
            "hide_blanks": {
              "description": "Schematic model submit option",
              "type": "boolean"
            },
            "file_annotations_upload": {
              "description": "Choose to add annotations to files during upload",
              "type": "boolean"
            }
          }
        }
      }
    }
  }
}