Delen via

Versiebeheer

  • Artikel

Elke clientaanvraag moet een expliciete API-versie opgeven als een queryreeksparameter. Bijvoorbeeld: https://{myconfig}.azconfig.io/kv?api-version=1.0.

api-version wordt uitgedrukt in de SemVer-indeling (major.minor). Bereik- of versieonderhandeling wordt niet ondersteund.

Dit artikel is van toepassing op API-versie 1.0.

Hieronder ziet u een overzicht van de mogelijke foutreacties die door de server worden geretourneerd wanneer de aangevraagde API-versie niet kan worden vergeleken.

API-versie niet opgegeven

Deze fout treedt op wanneer een client een aanvraag indient zonder een API-versie op te geven.

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
}

Niet-ondersteunde API-versie

Deze fout treedt op wanneer een door de client aangevraagde API-versie niet overeenkomt met een van de ondersteunde API-versies van de server.

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
}

Ongeldige API-versie

Deze fout treedt op wanneer een client een aanvraag met een API-versie indient, maar de waarde onjuist is of niet kan worden geparseerd door de server.

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
}

Niet-eenduidige API-versie

Deze fout treedt op wanneer een client een API-versie aanvraagt die niet eenduidig is voor de server (bijvoorbeeld meerdere verschillende waarden).

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
}