Versioning and changelog

The version policy and the dated list of changes.

The API is at version 1: its paths start with /v1, and the service marks every answer with api_version "1". The OpenAPI document's info.version is the same number.

Policy

  • Additive changes ship without notice: a new endpoint, a new optional input, a new field in an answer, a new error code or a new webhook event. Ignore fields you do not know, and handle codes you do not know by their status.
  • A removal or an incompatible change gets a new version, served beside the old one for at least 90 days, and is announced below before it ships.
  • Fixed sentences in message may be reworded at any time; branch on code.

Changelog

2026-09-28: Version 1: show breaks by hour

  • Every show spot, show break, local break and dropped break carries hour with breakNumber, and breakNumber runs straight through the show in hour order, as the network's printed schedules number the breaks (with four breaks an hour, Hour 2 holds Breaks 5 to 8).
  • ShowVehicle usualStart and usualEnd appear only when the station gave its usual hours.
  • Report dropped breaks as {hour, breakNumber, reason}, with hour the hour that holds that break, and send the week's version with the report: if the show's breaks were renumbered in a newer version, the report answers stale_version and saves nothing.
  • A saved dropped break that the week's current numbers cannot name comes back as {unreadable: true, reason} or {unavailable: true, hour, reason}. Neither is ever sent back in a report.
  • A show spot kept from an older version whose break is not on the week's break map, or is now a local break, carries breakNote. Tell spots apart by id.

2026-09-26: Version 1: first public release

  • Station keys with the read, report and acknowledge scopes.
  • Affiliations, weeks, the week's order, versions and acknowledgements, what is outstanding and the station's clearance.
  • Creatives with short-lived audio links, the week's audio as one ZIP, order exports in CSV, tab-separated and XML, and printable documents.
  • Affidavit and show certificate reports, log uploads with proposed matches, and applying the matches you accept.
  • Webhooks for new versions, arrived audio, approaching deadlines and reopened weeks.
  • An MCP server for assistants, this reference, the OpenAPI document and llms.txt.