{
"$id": "https://dpds.opendatamesh.org/resources/schemas/1.0.0-DRAFT.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#dpdsObject",
"title": "dataProductDescriptor",
"description": "The description of Data Product Descriptor v1.0.x documents without schema validation, as defined by Data Product Descriptor Specification v1.0",
"type": "object",
"properties": {
"dataProductDescriptor": {
"description": "",
"type": "string",
"format": "version"
},
"info": {
"$ref": "#/$defs/info"
},
"interfaceComponents": {
"$ref": "#/$defs/interfaceComponents"
},
"internalComponents": {
"$ref": "#/$defs/internalComponents"
},
"components": {
"$ref": "#/$defs/components"
},
"tags": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
},
"externalDocs": {
"$ref": "#/$defs/externalResource"
}
},
"required": [
"dataProductDescriptor",
"info",
"interfaceComponents"
],
"$defs": {
"info": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#infoObject",
"title": "Info Object",
"description": "The Info Object provides metadata about the data product. The metadata can be used by the platform or by cosumers if needed.",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string",
"readOnly": true,
"format": "uuid"
},
"fullyQualifiedName": {
"description": "",
"type": "string",
"format": "fqn"
},
"entityType": {
"description": "",
"type": "string",
"readOnly": true,
"format": "alphanumeric"
},
"name": {
"description": "",
"type": "string",
"format": "name"
},
"version": {
"description": "",
"type": "string",
"format": "version"
},
"displayName": {
"description": "",
"type": "string"
},
"description": {
"description": "",
"type": "string"
},
"domain": {
"description": "",
"type": "string",
"format": "name"
},
"owner": {
"$ref": "#/$defs/owner"
},
"contactPoints": {
"type": "array",
"items": {
"$ref": "#/$defs/contactPoint"
}
}
},
"required": [
"fullyQualifiedName",
"name",
"version",
"domain",
"owner"
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"owner": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#ownerObject",
"title": "Owner Object",
"description": "The Owner Object describes the data product's owner.",
"type": "object",
"properties": {
"id": {
"description": "",
"type": "string"
},
"name": {
"description": "",
"type": "string"
}
},
"required": ["id"],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"contactPoint": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#contactPointObject",
"title": "Contact Point Object",
"description": "The Contact Point Object describes a data product's contact point.",
"type": "object",
"properties": {
"name": {
"description": "",
"type": "string",
"format": "name"
},
"description": {
"description": "",
"type": "string"
},
"channel": {
"description": "",
"type": "string"
},
"address": {
"description": "",
"type": "string"
}
},
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"interfaceComponents": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#interfaceComponentsObject",
"title": "Interface Components Object",
"description": "The Interface Components Object it's a collection of all interface entities exposed by a data product.",
"type": "object",
"properties": {
"inputPorts": {
"type": "array",
"items": {
"$ref": "#/$defs/inputPortOrReference"
}
},
"outputPorts": {
"type": "array",
"items": {
"$ref": "#/$defs/outputPortOrReference"
}
},
"discoveryPorts": {
"type": "array",
"items": {
"$ref": "#/$defs/discoveryPortOrReference"
}
},
"observabilityPorts": {
"type": "array",
"items": {
"$ref": "#/$defs/observabilityPortOrReference"
}
},
"controlPorts": {
"type": "array",
"items": {
"$ref": "#/$defs/controlPortOrReference"
}
}
},
"required": ["outputPorts"],
"unevaluatedProperties": false
},
"inputPortOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/inputPort"
}
]
},
"inputPort": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#inputPortComponent",
"title": "Input Port Object",
"description": "The Input Port Component describes an input port of a data product.",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"$ref": "#/$defs/port"
}
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"outputPortOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/outputPort"
}
]
},
"outputPort": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#outputPortComponent",
"title": "Output Port Component",
"description": "The Output Port Component describes an output port of a data product.",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"$ref": "#/$defs/port"
}
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"discoveryPortOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/discoveryPort"
}
]
},
"discoveryPort": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#discoveryPortComponent",
"title": "The Discovey Port Component describes a discovery port of a data product.t",
"description": "",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"$ref": "#/$defs/port"
}
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"observabilityPortOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/observabilityPort"
}
]
},
"observabilityPort": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#observabilityPortComponent",
"title": "The Observability Port Component describes an observability port of a data product.",
"description": "",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"$ref": "#/$defs/port"
}
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"controlPortOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/controlPort"
}
]
},
"controlPort": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#controlPortComponent",
"title": "The Control Port Component describes a control port of a data product.",
"description": "",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"$ref": "#/$defs/port"
}
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"port": {
"properties": {
"promises": {
"$ref": "#/$defs/promisesOrReference"
},
"expectations": {
"$ref": "#/$defs/expectationsOrReference"
},
"contracts": {
"$ref": "#/$defs/contractsOrReference"
}
}
},
"promisesOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/promises"
}
]
},
"promises": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#promisesObject",
"title": "The Promises Object describes the data product's promises declared over a given port.",
"description": "",
"type": "object",
"properties": {
"platform": {
"description": "",
"type": "string"
},
"servicesType": {
"description": "",
"type": "string"
},
"api": {
"$ref": "#/$defs/standardDefinition"
},
"deprecationPolicy": {
"$ref": "#/$defs/specificationExtensionPoint"
},
"slo": {
"$ref": "#/$defs/specificationExtensionPoint"
}
},
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"standardDefinition": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#standardDefinitionObject",
"title": "Standard Definition Object",
"description": "The Standard Definition Object formally describes an object (ex. API object, provision template object, ecc ...) of interest following a given standard specification.",
"type": "object",
"properties": {
"description": {
"description": "",
"type": "string"
},
"specification": {
"description": "",
"type": "string"
},
"version": {
"description": "",
"type": "string"
},
"definition": {
"$ref": "#/$defs/objectOrStringOrReference"
},
"externalDocs": {
"$ref": "#/$defs/externalResource"
}
},
"required": ["specification","definition"],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"expectationsOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/expectations"
}
]
},
"expectations": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#expectationsObject",
"title": "Expectations Object",
"description": "The Expectations Object describes the data product's expectations declared over a given port.",
"type": "object",
"properties": {
"audience": {
"$ref": "#/$defs/specificationExtensionPoint"
},
"usage": {
"$ref": "#/$defs/specificationExtensionPoint"
}
},
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"contractsOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/contracts"
}
]
},
"contracts": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#contractsObject",
"title": "Expectations Object",
"description": "The Contracts Object describes the data product's contracts declared over a given port.",
"type": "object",
"properties": {
"termsAndConditions": {
"$ref": "#/$defs/specificationExtensionPoint"
},
"billingPolicy": {
"$ref": "#/$defs/specificationExtensionPoint"
},
"sla": {
"$ref": "#/$defs/specificationExtensionPoint"
}
},
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"internalComponents": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#internalComponentsObject",
"title": "Internal Components Object",
"description": "The Internal Components Object it's a collection of all internal entities that compose a data product.",
"type": "object",
"properties": {
"applicationComponents": {
"description": "",
"type": "array",
"items": {
"$ref": "#/$defs/applicationComponentOrReference"
}
},
"infrastructuralComponents": {
"description": "",
"type": "array",
"items": {
"$ref": "#/$defs/infrastructuralComponentOrReference"
}
}
}
},
"applicationComponentOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/applicationComponent"
}
]
},
"applicationComponent": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#applicationComponent",
"title": "Application Component",
"description": "The Application Component describes an internal application component used by the data product to provide services through its ports.",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"title": "applicationComponent",
"properties": {
"platform": {
"description": "",
"type": "string"
},
"applicationType": {
"description": "",
"type": "string"
},
"buildInfo": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#buildInfoObject",
"title": "Build Info",
"description": "The Build Info Object contains all the informations required to build an Application Component",
"type": "object",
"properties": {
"service": {
"$ref": "#/$defs/reference"
},
"template": {
"$ref": "#/$defs/objectOrStringOrReference"
},
"configurations": {
"$ref": "#/$defs/objectOrStringOrReference"
}
}
},
"deployInfo": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#deployInfoObject",
"title": "Build Info",
"description": "The Deploy Info Object contains all the informations required to deploy an Application Component",
"type": "object",
"properties": {
"service": {
"$ref": "#/$defs/reference"
},
"template": {
"$ref": "#/$defs/objectOrStringOrReference"
},
"configurations": {
"$ref": "#/$defs/objectOrStringOrReference"
}
}
},
"consumesFrom": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
},
"providesTo": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
},
"dependsOn": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
}
}
}
],
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"infrastructuralComponentOrReference": {
"oneOf": [
{
"$ref": "#/$defs/reference"
},
{
"$ref": "#/$defs/infrastructuralComponent"
}
]
},
"infrastructuralComponent": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#infrastructuralComponent",
"title": "Infrastructural Component",
"description": "The Infrastructural Component describes an internal infrastructural component used by the data product to run its applications and store its data.",
"type": "object",
"allOf": [
{
"$ref": "#/$defs/entity"
},
{
"title": "infrastructuralComponent",
"properties": {
"platform": {
"description": "",
"type": "string"
},
"infrastructureType": {
"description": "",
"type": "string"
},
"provisionInfo": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#provisionInfoObject",
"title": "Build Info",
"description": "The Provision Info Object contains all the informations required to provision an Infrastructural Component",
"type": "object",
"properties": {
"service": {
"$ref": "#/$defs/reference"
},
"template": {
"$ref": "#/$defs/objectOrStringOrReference"
},
"configurations": {
"$ref": "#/$defs/objectOrStringOrReference"
}
}
},
"dependsOn": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
}
}
}
]
},
"components": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#componentsObject",
"title": "Components Object",
"description": "The Components Object holds a set of reusable objects for different aspects of the DPDS.",
"type": "object",
"properties": {
"inputPorts": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/inputPortOrReference"
}
},
"outputPorts": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/outputPortOrReference"
}
},
"discoveryPorts": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/discoveryPortOrReference"
}
},
"observabilityPorts": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/observabilityPortOrReference"
}
},
"controlPorts": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/controlPortOrReference"
}
},
"applicationComponents": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/applicationComponentOrReference"
}
},
"infrastructuralComponents": {
"description": "",
"type": "object",
"additionalProperties": {
"$ref": "#/$defs/infrastructuralComponentOrReference"
}
}
},
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"reference": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#referenceObject",
"title": "Reference Object",
"description": "The Reference Object allows referencing other components in the Data Product Descriptor Document, internally and externally.",
"type": "object",
"properties": {
"$ref": {
"description": "",
"type": "string",
"format": "uri-reference"
},
"mediaType": {
"description": "",
"type": "string"
},
"description": {
"description": "",
"type": "string"
}
},
"required": [
"$ref"
],
"unevaluatedProperties": false
},
"externalResource": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#externalResourceObject",
"title": "External Resource Object",
"description": "The External Resource Object allows referencing an external resource like a documentation page or a standard definition.",
"type": "object",
"properties": {
"description": {
"description": "",
"type": "string"
},
"mediaType": {
"description": "",
"type": "string"
},
"$href": {
"description": "",
"type": "string",
"format": "uri"
}
},
"required": [
"$href"
],
"unevaluatedProperties": false
},
"objectOrStringOrReference": {
"oneOf": [
{
"title": "object",
"description": "An inline JSON Object",
"type": "object"
},
{
"title": "string",
"description": "An inline String",
"type": "string"
},
{
"$ref": "#/$defs/reference"
}
]
},
"specificationExtensionPoint": {
"$comment": "https://dpds.opendatamesh.org/specifications1.0.0-DRAFT/#specificationExtensionPoint",
"title": "Specification Extension Point",
"description": "A Specification Extension Point marks specific part of the Data Product Descriptor Specification that are left open to extensions or futher evolution of the standard.",
"type": "object",
"properties": {
"description": {
"description": "",
"type": "string"
},
"externalDocs": {
"$ref": "#/$defs/externalResource"
}
},
"patternProperties": {
"^x-": true
},
"unevaluatedProperties": false
},
"entity": {
"properties": {
"id": {
"description": "",
"type": "string",
"format": "uuid",
"readOnly": true
},
"fullyQualifiedName": {
"description": "",
"type": "string",
"format": "fqn"
},
"entityType": {
"description": "",
"type": "string",
"format": "alphanumeric"
},
"name": {
"description": "",
"type": "string",
"format": "name"
},
"version": {
"description": "",
"type": "string",
"format": "version"
},
"displayName": {
"description": "",
"type": "string"
},
"description": {
"description": "",
"type": "string"
},
"componentGroup": {
"description": "",
"type": "string",
"format": "name"
},
"tags": {
"description": "",
"type": "array",
"items": {
"type": "string"
}
},
"externalDocs": {
"$ref": "#/$defs/externalResource"
}
},
"required": [
"fullyQualifiedName",
"name",
"version"
]
}
}
}