Gestion de version

Article
06/01/2023

Chaque demande du client doit fournir une version d’API explicite en tant que paramètre de chaîne de requête. Par exemple : https://{myconfig}.azconfig.io/kv?api-version=1.0.

La valeur api-version est exprimée au format SemVer (majeure.mineure). La négociation de plage ou de version n’est pas prise en charge.

Cet article s’applique à la version 1.0 de l’API.

L’exemple suivant présente un résumé des réponses d’erreur possibles que le serveur retourne quand la version d’API n’a pas de correspondance.

Version d’API non spécifiée

Cette erreur se produit quand un client effectue une demande sans fournir de version d’API.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "API version is not specified",
  "name": "api-version",
  "detail": "An API version is required, but was not specified.",
  "status": 400
}

Version d’API non prise en charge

Cette erreur se produit quand une version d’API demandée par un client ne correspond à aucune des versions d’API que le serveur prend en charge.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Unsupported API version",
  "name": "api-version",
  "detail": "The HTTP resource that matches the request URI '{request uri}' does not support the API version '{api-version}'.",
  "status": 400
}

Version d’API non valide

Cette erreur se produit quand un client effectue une demande avec une version d’API dont la valeur est mal formée ou ne peut pas être analysée par le serveur.

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8  
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Invalid API version",
  "name": "api-version",
  "detail": "The HTTP resource that matches the request URI '{request uri}' does not support the API version '{api-version}'.",
  "status": 400
}

Version d’API ambiguë

Cette erreur se produit lorsqu’un client demande une version d’API ambiguë pour le serveur (par exemple, plusieurs valeurs différentes).

HTTP/1.1 400 Bad Request
Content-Type: application/problem+json; charset=utf-8
{
  "type": "https://azconfig.io/errors/invalid-argument",
  "title": "Ambiguous API version",
  "name": "api-version",
  "detail": "The following API versions were requested: {comma separated api versions}. At most, only a single API version may be specified. Please update the intended API version and retry the request.",
  "status": 400
}

Partage via