Skip to content

What does "deprecated" mean?

lukmay edited this page Oct 22, 2024 · 5 revisions

In the context of technology and software, "deprecated" refers to a feature, function, practice or (web)page that is no longer recommended for use and may be removed in future updates.

While it may still be functional, its usage is discouraged because it has been **replaced **by a more efficient, secure, or effective alternative. When a feature is marked as deprecated, it means that users are signaled to transition to newer options to ensure compatibility and take advantage of improvements.

As an example, on a certain Open Data Hub documentation page or tutorial, we might indicate that it is "deprecated", meaning that its content is no longer updated - moreover, we might signal another webpage replacing the deprecated one, where the current and up-to-date information is stored.

Note that every page that has been replaced by a more updated one, remains active on the Open Data Hub website for at least 12 months, in order for the customer to have enough time to adjust and for us to consider and handle all the different dependencies.

In the context of the Open Data Hub there are several examples of this.

In the content API - in Swagger - a user can see from the Schemas if an Endpoint is deprecated or if one or more attributes within the JSON response from the API are deprecated. image

Another example is provided in the TimeSeries API (https://swagger.opendatahub.com/?url=https://mobility.api.opendatahub.com/v2/apispec), also reported here below, where the deprecated timefields are described the same way as in the Content API. image

How to recognize if a field is "deprecated" in the Data Browser

Deprecated fields are indicated by an orange dot or an orange outline, as shown in the following examples:

Note: Clicking on this marker will provide more information and a reference to the relevant page.

databrowser1.mp4
databrowser2.mp4
Clone this wiki locally