Aller au contenu principal

Versions de l'API

L'API est proposée comme un unique point d'accès GraphQL à l'adresse https://data.bafu.admin.ch/api. Il n'existe ni segment de version dans l'URL ni en-tête de version ; tous les clients utilisent le schéma courant. Les modifications notables du schéma sont consignées dans l'historique des versions ci-dessous. Les versions suivent le versionnage sémantique (Major.Minor.Patch) : le numéro majeur augmente lors d'une modification non rétrocompatible, le numéro mineur lors d'une nouvelle fonctionnalité rétrocompatible et le numéro de correctif lors d'une correction rétrocompatible. La version retrace l'évolution du schéma et n'est pas sélectionnée par les clients.

Historique des versions

Légende : Major une modification non rétrocompatible pouvant nécessiter une adaptation des clients. Minor une nouvelle fonctionnalité rétrocompatible. Patch une correction rétrocompatible.

VersionDate de publicationModificationDescription
1.0.02026-07-03MajorVersion initiale avec les jeux de données water.observations et water.nawa_trend.

Évolution du schéma

Le schéma est étendu au fil du temps à mesure que de nouveaux produits de données sont publiés. Ces modifications sont additives et rétrocompatibles :

  • nouveaux espaces de noms, types et champs,
  • nouveaux champs de filtre sur les types existants.

Les modifications additives n'affectent pas les requêtes existantes. Une requête qui sélectionne un ensemble explicite de champs continue de retourner ces champs même lorsque de nouveaux champs sont ajoutés ailleurs dans le schéma.

Le schéma courant peut être consulté à tout moment par introspection GraphQL — par exemple via l'explorateur GraphiQL.

Changements incompatibles

Les modifications non rétrocompatibles — telles que le renommage ou la suppression d'un champ ou la modification du type d'un champ — sont évitées dans la mesure du possible. Si une telle modification devait s'avérer inévitable, elle est annoncée à l'avance sur cette page afin que les clients concernés puissent s'adapter.