This document details the deprecation policy for both API functionality and datasets.
As with any software consisting of many components, features naturally evolve over time. To warn you about upcoming changes, we use a deprecation policy for APIs and datasets that are subject to change. We strive to provide either an alternative or updated version and will note this in the deprecation notice. We also strive to provide sufficient time between the deprecation and eventual sunset of the API or dataset to give you time to update to a new API version or dataset.
Once an API or API version has been deprecated this will be indicated in the API response with a X-KNMI-Deprecation header.
This header indicates the sunset date of the API or API version and where to find the deprecation notice.
Once the sunset date has passed, the deprecated API or API version is no longer functional. The minimum time between deprecation and sunset is two months.
An example response header that contains deprecation information is as follows:
X-KNMI-Deprecation: "sunset=2024-06-01T00:00:00Z; info=https://developer.dataplatform.knmi.nl/deprecation-edr-api-unversioned"
Once a dataset has been deprecated, this will be indicated in the Open Data API response with a X-KNMI-Deprecation header.
This header indicates the sunset date of the dataset and where to find the deprecation notice. Additionally, this
information will appear in the Data Catalog entry of the dataset.
Once the sunset date has passed, the deprecated dataset will no longer receive updates. The data will remain accessible. The minimum time between deprecation and sunset is two months.
An example response header of the Open Data API that contains deprecation information is as follows:
X-KNMI-Deprecation: "sunset=2024-07-17T00:00:00Z; info=https://developer.dataplatform.knmi.nl/deprecation-cell-tracking_1"
We provide example scripts that automatically check and log the deprecation header.
No policy can cover every possible situation. KNMI Data Platform is an evolving system and this document will evolve with it. In situations where this policy does not fit, we will communicate this through our newsletter and in all relevant deprecation notices.