Documentation

Deprecations

An endpoint is never switched off unannounced. When one is being retired, the API, the reference and this section all say so, with the same dates.

How a deprecation is signalled

Response headers. Every response from a deprecated endpoint carries three headers:

Deprecation: @1785456000
Sunset: Wed, 31 Mar 2027 00:00:00 GMT
Link: <https://technology.road.io/docs/platform/reference/deprecations/ocpp-command-search-v1>; rel="deprecation"; type="text/html"

Deprecation (RFC 9745) is the day the deprecation took effect, as a Unix timestamp. Sunset (RFC 8594) is the day the endpoint stops answering. The Link relation points at the notice for that endpoint. Log these headers in your client: they are the earliest signal you will get, and they appear on error responses too.

The OpenAPI spec. The operation is marked deprecated: true, and an x-deprecated extension carries the facts in machine-readable form:

deprecated: true
x-deprecated:
  deprecatedAt: 2026-07-31
  sunset: 2027-03-31
  replacedBy: postV2EvseControllersByEvseControllerCommandsSearch
  notice: https://technology.road.io/docs/platform/reference/deprecations/ocpp-command-search-v1

replacedBy is the operationId of the endpoint to move to. Generated clients pick up the deprecated flag, so a compiler or IDE warns wherever the old call is still used.

The reference. A deprecated endpoint stays in the API reference until it is removed, with a notice under its access box that names the dates and links to the replacement and to the notice page. From the sunset date it is shown as retired.

A notice page. Each deprecation has a page in this section. Its header states the endpoint, the dates and the replacement; the body explains why, who needs to act, what changes and how to migrate a request.

What to expect

  • Until the sunset date the endpoint keeps answering, though it may already reject requests its replacement cannot express. The notice says which.
  • From the sunset date the endpoint answers 410 Gone, with the replacement named in the error, and is removed once traffic has stopped.
  • The notice page stays online after the sunset date, marked as retired.

Current notices