Skip to content

Changelog

Unreleased

  • New spec page Communication: the messages between the agents of different projects (import, change notice, ack, request, decision, cited file), their fields and states, ids, and the rules (metadata only, never blocks, a person settles). Home, Overview, the spec overview and the full picture link to it.
  • Schema and types are named on Home, the full picture (a new "Schema and types" row) and What to write first (type is Useful, physical_type None).

  • New column fields type (an ODCS logical type, filled from the data by a tool) and physical_type (optional storage type). A declared type that disagrees with the latest build is a warning; a unit on a non-numeric type is a warning.

  • A unit is checked against the full UCUM table: unknown symbols are errors (for example [sqft]; the code is [sft_i]). Breaking for files that used a unit that is syntactically valid but not UCUM.
  • The card shows the ODCS type where it showed the storage dtype.
  • Mappings: type to ODCS logicalType, physical_type to physicalType, unit, currency and per to customProperties.
  • Schema changes covers a column's type changing: widening is not breaking, narrowing is.
  • Schema changes: new section on what a tool detects by comparing two published builds (type change, a x100 or x1000 jump in a column's range, blanks appearing, a reused name), and the rules that keep those signals quiet. The columns page says which fields make up the schema.
  • New page Schema changes: what to declare for each kind of change, and what a reader does about it.
  • New project field removed_datasets (name, removed, use_instead, note) for a retired or split dataset.
  • A column alias equal to a current column, and a removed column back in the data, may be reported as warnings while publishing; they stay errors in a check.
  • An alias until applies to column aliases too: after it, the former name no longer resolves.

v0.1 (draft), 2026-11-12

First public draft. File format version 1: project, datasets (columns, profile, as-of dates, facts, use cases, hazards, removed columns, not-exported, aliases, pricing) and relationships. JSON Schema generated from the first implementation. Mappings to ODCS (price), ODPS 4.1 (pricing plans) and Apache Ossie (relationships).

  • File layout: oryxkb/project.yaml (optional oryxkb/datasets/.yaml, oryxkb/relationships.yaml).
  • Profile fields move into one profile: block (period, entities, coverage_by, series); series defaults to the grain minus the period. outputs is no longer part of the spec (oryxkb still accepts it).