Skip to content

required-optional.md

Latest commit

 

History

History
47 lines (34 loc) · 2.23 KB

required-optional.md

File metadata and controls

47 lines (34 loc) · 2.23 KB

What are the required and optional sections in ODPS?

The Open Data Product Specification (ODPS) defines a YAML-based standard to describe interoperable, AI-friendly, and monetizable data products. This guide lists the required sections only, based on ODPS v4.0.

Required Sections

To comply with the ODPS schema, the following minimum structure is required:

schema: https://opendataproducts.org/v4.0/schema/odps.yaml
version: 4.0

product:
  details:
    en:
      name: City Bike Stations
      productID: citybike-stations-001
      description: Public data about station locations and availability in real-time.
      visibility: public
      status: draft
      type: dataset

Required Elements:

Field Description
schema Points to the official ODPS schema version being used.
version Declares the version of the ODPS.
product.details.en At least one language block (en, fi, ar, etc.) is mandatory.
→ name The name of the data product.
→ productID A unique, machine-readable identifier.
→ description Human-readable explanation of the data product.
→ visibility Visibility level: private, invitation, organisation, dataspace, public
→ type The type of the product. Options are derived from examples and lists found from academic literature.
→ status The status of the product: announcement, draft, development, testing, acceptance, production, sunset, retired

This structure is the minimum required to produce a valid ODPS YAML file. All other aspects are optional.

👉 Download the minimal ODPS YAML used in this example

BACK TO INDEX