OpenMetadata · Schema

Container

Data CatalogMetadataData GovernanceData LineageData QualityOpen SourceData DiscoveryData Observability

Properties

Name Type Description
id string
name string
fullyQualifiedName string
displayName string
description string
version number
updatedAt integer
updatedBy string
impersonatedBy string
href string
owners array
service object
parent object
children array
dataModel object
prefix string
numberOfObjects number
size number
fileFormats array
serviceType string
followers array
tags array
changeDescription object
incrementalChangeDescription object
deleted boolean
retentionPeriod string
extension object
sampleData object
sourceUrl string
fullPath string
domains array
dataProducts array
dataContract object
votes object
lifeCycle object
certification object
sourceHash string
entityStatus string
provider string
style object
experts array
reviewers array
usageSummary object
View JSON Schema on GitHub

JSON Schema

container.json Raw ↑ 
{
  "required": [
    "id",
    "name",
    "service"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "pattern": "^((?!::).)*$",
      "type": "string"
    },
    "fullyQualifiedName": {
      "maxLength": 3072,
      "minLength": 1,
      "type": "string"
    },
    "displayName": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "version": {
      "type": "number",
      "format": "double"
    },
    "updatedAt": {
      "type": "integer",
      "format": "int64"
    },
    "updatedBy": {
      "type": "string"
    },
    "impersonatedBy": {
      "type": "string"
    },
    "href": {
      "type": "string",
      "format": "uri"
    },
    "owners": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "service": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "parent": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "children": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataModel": {
      "$ref": "#/components/schemas/ContainerDataModel"
    },
    "prefix": {
      "type": "string"
    },
    "numberOfObjects": {
      "type": "number",
      "format": "double"
    },
    "size": {
      "type": "number",
      "format": "double"
    },
    "fileFormats": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "zip",
          "gz",
          "zstd",
          "csv",
          "tsv",
          "json",
          "parquet",
          "avro",
          "MF4"
        ]
      }
    },
    "serviceType": {
      "type": "string",
      "enum": [
        "S3",
        "ADLS",
        "GCS",
        "CustomStorage"
      ]
    },
    "followers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "tags": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/TagLabel"
      }
    },
    "changeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "incrementalChangeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "deleted": {
      "type": "boolean"
    },
    "retentionPeriod": {
      "type": "string"
    },
    "extension": {
      "type": "object"
    },
    "sampleData": {
      "$ref": "#/components/schemas/TableData"
    },
    "sourceUrl": {
      "type": "string"
    },
    "fullPath": {
      "type": "string"
    },
    "domains": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataProducts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "dataContract": {
      "$ref": "#/components/schemas/EntityReference"
    },
    "votes": {
      "$ref": "#/components/schemas/Votes"
    },
    "lifeCycle": {
      "$ref": "#/components/schemas/LifeCycle"
    },
    "certification": {
      "$ref": "#/components/schemas/AssetCertification"
    },
    "sourceHash": {
      "maxLength": 32,
      "minLength": 1,
      "type": "string"
    },
    "entityStatus": {
      "type": "string",
      "enum": [
        "Draft",
        "In Review",
        "Approved",
        "Archived",
        "Deprecated",
        "Rejected",
        "Unprocessed"
      ]
    },
    "provider": {
      "type": "string",
      "enum": [
        "system",
        "user",
        "automation"
      ]
    },
    "style": {
      "$ref": "#/components/schemas/Style"
    },
    "experts": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "reviewers": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/EntityReference"
      }
    },
    "usageSummary": {
      "$ref": "#/components/schemas/UsageDetails"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openmetadata/main/json-schema/container.json"
}