ApiResourceVersion interface

Paket:

azure-devops-extension-api

Stellt Versionsinformationen für eine REST-API-Ressource dar

Eigenschaften

apiVersion	Zeichenfolgendarstellung der öffentlichen API-Version. Dies ist die Version, die die Öffentlichkeit sieht und die für eine große Gruppe von Diensten verwendet wird (z. B. die TFS 1.0 API)
isPreview	Befindet sich die öffentliche API-Version in der Vorschau.
resourceVersion	Version der internen Ressource. Dies wird pro Ressource definiert und verwendet, um die Build-zu-Build-Kompatibilität von API-Änderungen innerhalb einer bestimmten öffentlichen API-Version (in der Vorschau) zu unterstützen. Beispielsweise kann die Datenstruktur einer Ressource innerhalb des Veröffentlichungszyklus der TFS 1.0-API, während sie sich noch in der Vorschau befindet, geändert werden. Diese Ressource kann so versioniert werden, dass ältere Clients weiterhin funktionieren (Anforderungen werden an die ältere Version gesendet) und neue/aktualisierte Clients mit der neuen Version der Ressource kommunizieren.

Details zur Eigenschaft

apiVersion

Zeichenfolgendarstellung der öffentlichen API-Version. Dies ist die Version, die die Öffentlichkeit sieht und die für eine große Gruppe von Diensten verwendet wird (z. B. die TFS 1.0 API)

apiVersion: string

Eigenschaftswert

string

isPreview

Befindet sich die öffentliche API-Version in der Vorschau.

isPreview: boolean

Eigenschaftswert

boolean

resourceVersion

Version der internen Ressource. Dies wird pro Ressource definiert und verwendet, um die Build-zu-Build-Kompatibilität von API-Änderungen innerhalb einer bestimmten öffentlichen API-Version (in der Vorschau) zu unterstützen. Beispielsweise kann die Datenstruktur einer Ressource innerhalb des Veröffentlichungszyklus der TFS 1.0-API, während sie sich noch in der Vorschau befindet, geändert werden. Diese Ressource kann so versioniert werden, dass ältere Clients weiterhin funktionieren (Anforderungen werden an die ältere Version gesendet) und neue/aktualisierte Clients mit der neuen Version der Ressource kommunizieren.

resourceVersion: number

Eigenschaftswert

number