Skip to content
SetuसेतुChangelog

Changelog and versions

How Trinetra's data formats change, what version 1 of the data API promises, and every format change Setu has found between catalogue builds.

Where things stand

Live products keep the promise below
Products still in build can change their formats without notice. Setu records every change it can detect, below.

Versions

  • Data API: v1. The version is part of the address, /api/v1/. A change that version 1 cannot absorb goes to a new address, /api/v2/, and v1 keeps working beside it for at least six months.
  • Products. Each manifest carries a version in semantic versioning: the patch number for fixes, the minor number for additions, the major number for breaking changes.
  • The catalogue. catalog.json carries catalog_version (1.1.0) and follows the same rules as the data it describes.
  • Sangam records. Each record carries schema_version; minor versions only add optional fields.

The v1 stability promise

For every dataset of a product marked live:

Addresses stayEvery /api/v1/ address in the catalogue keeps serving its dataset. If a file has to move, the old address is kept or redirected for at least 90 days after the move is announced here.
Additions need no noticeNew datasets, files, fields and category values can appear at any time. Clients must ignore what they do not know.
Breaking changes are announced firstRemoving or renaming a field, changing its type, unit or meaning, changing coordinate order or time zone, or removing a dataset is announced here at least 30 days ahead, and the old form is kept beside the new one for that time. Otherwise the change goes to /api/v2/.
Provenance is never droppedManifests keep module, version, generated_at, simulated, seed, sources and files. A simulated flag or a source's credit is never removed from a dataset that has one.

What the promise does not cover

  • The values themselves. Data is refreshed on each product's schedule, and corrections to past values are expected.
  • Setu's inferred schemas, examples and "one of" value lists. They describe the current files; they are not a contract.
  • The order of keys in an object or of items in an array, unless a product documents it.
  • Advisory wording, which follows the official agencies and can change at any time.
  • A safety correction. If a published value could mislead someone about a flood, heat, sea or road hazard, it is fixed at once and the fix is recorded here.

Changes detected

Each catalogue build flattens every dataset's inferred schema into paths and types and compares them with the previous build. A path that disappears, or a type that narrows, is marked possibly breaking. Schemas are inferred from the data, so an optional field that is absent from one export shows as missing: treat each entry as a prompt to check, not as proof.

  • Loading.

Follow changes in code: /api/v1/setu/changes.json lists the same entries, newest first, each with at, kind, added, removed and changed.

Product versions

ProductStatusVersionManifest writtenDatasetsManifest
Loading.