json.schema.api.domains.createDataProduct.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/domains/createDataProduct.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "CreateDataProductRequest",
  "description": "Create DataProduct API request",
  "type": "object",
  "javaType": "org.openmetadata.schema.api.domains.CreateDataProduct",
  "javaInterfaces": [
    "org.openmetadata.schema.CreateEntity"
  ],
  "properties": {
    "name": {
      "description": "A unique name of the DataProduct",
      "$ref": "../../type/basic.json#/definitions/entityName"
    },
    "fullyQualifiedName": {
      "description": "FullyQualifiedName of the Domain.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
    },
    "displayName": {
      "description": "Name used for display purposes. Example 'Customer Churn', 'Sentiment Analysis', etc.",
      "type": "string"
    },
    "description": {
      "description": "Description of the DataProduct.",
      "$ref": "../../type/basic.json#/definitions/markdown"
    },
    "style": {
      "$ref": "../../type/basic.json#/definitions/style"
    },
    "owners": {
      "description": "Owners of this DataProduct.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "domain": {
      "description": "Fully qualified name of the Domain the DataProduct belongs to.",
      "$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName",
      "default": null
    },
    "experts": {
      "description": "List of user/login names of users who are experts in this DataProduct.",
      "type" : "array",
      "items": {
        "type": "string"
      },
      "default": null
    },
    "assets": {
      "description": "Data assets collection that is part of this data product.",
      "$ref": "../../type/entityReferenceList.json",
      "default": null
    },
    "extension": {
      "description": "Entity extension data with custom attributes added to the entity.",
      "$ref": "../../type/basic.json#/definitions/entityExtension"
    }
  },
  "required": [
    "name",
    "description"
  ],
  "additionalProperties": false
}