Sürüm Oluşturma

  • Makale

Her istemci isteğinin sorgu dizesi parametresi olarak açık bir API sürümü sağlaması gerekir. Örneğin: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version SemVer (major.minor) biçiminde ifade edilir. Aralık veya sürüm anlaşması desteklenmez.

Bu makale API sürüm 1.0 için geçerlidir.

Aşağıda, istenen API sürümü eşleştirilemiyorsa sunucu tarafından döndürülen olası hata yanıtlarının özeti özetlenmiştir.

API sürümü belirtilmemiş

Bu hata, bir istemci API sürümü sağlamadan istekte bulunursa oluşur.

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
}

Desteklenmeyen API sürümü

Bu hata, istemci tarafından istenen BIR API sürümü sunucu tarafından desteklenen API sürümlerinden herhangi biriyle eşleşmediğinde oluşur.

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
}

Geçersiz API sürümü

Bu hata, bir istemci API sürümüyle istekte bulunsa ancak değer yanlış biçimlendirilmişse veya sunucu tarafından ayrıştırılamıyorsa oluşur.

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
}

Belirsiz API sürümü

Bu hata, bir istemci sunucu için belirsiz bir API sürümü istediğinde oluşur (örneğin, birden çok farklı değer).

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
}