Skip to content
This repository has been archived by the owner on Jan 3, 2020. It is now read-only.

Latest commit

 

History

History
24 lines (16 loc) · 832 Bytes

deprecation.rst

File metadata and controls

24 lines (16 loc) · 832 Bytes

Deprecation

A track of the client version will be kept to know after which date each old version can be shutdown.

The date of the end of support is provided in the API root URL (e.g. /v1)

Using the Alert response header, the server can communicate any potential warning messages, information, or other alerts.

The value is JSON mapping with the following attributes:

  • code: one of the strings "soft-eol" or "hard-eol";
  • message: a human-readable message (optional);
  • url: a URL at which more information is available (optional).

A error response can be returned if the client version is too old, or the service had been remplaced with a new and better service using a new API version.

See details in configuration to activate deprecation.