Partilhar via

Controlo de versões

  • Artigo

Cada pedido de cliente tem de fornecer uma versão explícita da API como um parâmetro de cadeia de consulta. Por exemplo: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version é expresso no formato SemVer (major.minor). A negociação de intervalos ou versões não é suportada.

Este artigo aplica-se à versão 1.0 da API.

O seguinte descreve um resumo das possíveis respostas de erro devolvidas pelo servidor quando a versão da API pedida não pode ser correspondida.

Versão da API não especificada

Este erro ocorre quando um cliente faz um pedido sem fornecer uma versão da 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
}

Versão da API não suportada

Este erro ocorre quando uma versão da API pedida por um cliente não corresponde a nenhuma das versões de API suportadas pelo servidor.

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
}

Versão de API inválida

Este erro ocorre quando um cliente faz um pedido com uma versão de API, mas o valor está incorreto ou não pode ser analisado pelo servidor.

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
}

Versão ambígua da API

Este erro ocorre quando um cliente pede uma versão da API que é ambígua ao servidor (por exemplo, vários valores diferentes).

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
}