Quickstart

The Data Product Descriptor Specification (DPDS) is the ultimate source of knowledge regarding this data product description format. However, its length is daunting to newcomers and makes it hard for experienced users to find specific bits of information. This page provides a soft landing for readers not yet familiar with DPDS and is organized by topic, simplifying browsing.

The first page of the quickstart describes the architecture and purpose of the Trip Execution Data Product used in the other pages to explain the specification. The following pages introduce the syntax and structure of a data product descriptor document, its main building blocks and a minimal data product descriptor document. Afterward, the different blocks are detailed, starting from the most common and progressing toward advanced ones.

• Trip Execution Data Product Overview: architecture and purpose of the example data product
• Data Product Descriptor Document Overview: JSON, YAML
• Minimal Descriptor Document: dataProductDescriptor and info
• Interface Components: interfaceComponents, promises, expectations and obligations
• Application Components: applicationComponents, buildService and deploymentService
• Infrastructural Components: infrastructuralComponents and provisioningService
• Reusing descriptions: components and $ref.
• External Resources: $href and mediaType.
• Providing documentation: summary, description and externalDocs
• Extending the specification: custom fields, extension points and esternal standards
• Putting all together: files structure of the Trip Execution descriptor document