TruckerTechTruckerTech

Developer Lab · Policies

Versioning

Each document has its own semantic version, and a published version never changes.

  • Major for a breaking change: a path, operation, response field or enum value removed, a type narrowed, a new required request field, or a response status that changes meaning.
  • Minor for an addition, and patch for a change to descriptions only.
  • Exact URLs never change. A fix is a new version, for example /developers/specs/connectors/1.1.0/openapi.json.
  • Two aliases. /developers/specs/connectors/v1/openapi.json is the newest 1.x, and /developers/specs/connectors/latest/openapi.json the newest release. Each alias answers with Link: <exact URL>; rel="canonical".
  • Component versions (canon, envelope, manifest, port, protocol) are in x-truckertech-versions, beside the document's own version.
  • Every version has a changelog entry, and the machine index lists each version's files with their SHA-256.