Skip to main content

Deprecated endpoints link their change list entry

2026-11-17 · Not breaking · Upcoming: not yet in production

Link of a deprecated or closed endpoint names its own entry in the change list on the developer portal, the same in every environment, instead of /openapi/v1.json on the API host.

What changed

  • For example Link: <https://developers.orderex.se/changelog/0007-quantities-reported-as-facts>; rel="deprecation" on PATCH /api/v1/orders/{id}/lines/{lineId}/quantities.
  • The description of each deprecated operation in this document ends with the address of its entry.
  • A deprecated endpoint whose end date is set also answers with Sunset (RFC 8594), at least 6 months after Deprecation unless the exception for security and law in the versioning policy applies, and a second Link to the same entry with rel="sunset"; a closed endpoint has no Sunset, and none of the three deprecated endpoints has one today.
  • Deprecation stays 2027-01-01 (@1798761600) for PATCH .../quantities, PATCH .../delivery and PATCH .../lines/{lineId}/status.
  • Nothing you send or read changes.

Affected operations

  • PATCH /api/v1/orders/{id}/lines/{lineId}/quantities
  • PATCH /api/v1/orders/{id}/delivery
  • PATCH /api/v1/orders/{id}/lines/{lineId}/status

What you do

  • Nothing. Follow Link when you want to read why an endpoint is deprecated and what replaces it.

The versioning policy says what counts as a breaking change, how one is announced and how long a deprecated endpoint stays.