json.schema.api.docStore.createDocument.json Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openmetadata-spec Show documentation

There is a newer version: 1.6.0-rc1

{
  "$id": "https://open-metadata.org/schema/entity/docStore/document.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "Document",
  "description": "This schema defines Document. A Generic entity to capture any kind of Json Payload.",
  "type": "object",
  "javaType": "org.openmetadata.schema.entities.docStore.CreateDocument",
  "javaInterfaces": ["org.openmetadata.schema.CreateEntity", "org.openmetadata.schema.DocStoreEntityInterface"],
  "properties": {
    "name": {
      "description": "Name of the DocStore",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "displayName": {
      "description": "Display Name that identifies this column name.",
      "type": "string"
    },
    "fullyQualifiedName": {
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "description": {
      "description": "Description of the DocStore Entity.",
      "type": "string"
    },
    "entityType": {
      "description": "Type of the Entity stored in DocStore.",
      "type": "string"
    },
    "data": {
      "$ref": "../../entity/docStore/document.json#/definitions/data"
    },
    "domain" : {
      "description": "Fully qualified name of the domain the Table belongs to.",
      "type": "string"
    }
  },
  "required": ["name", "fullyQualifiedName","entityType", "data"],
  "additionalProperties": false
}