Zurück

generaltranslation v8

Brian Lou avatarBrian Lou
generaltranslation8.0.0apitranslation

Übersicht

In generaltranslation v8 nehmen wir grundlegende Änderungen an unserer API vor und setzen einige API‑Funktionen und Endpunkte außer Betrieb.

Ältere Versionen der API werden nicht mehr unterstützt.

generaltranslation‑Versionen vor 7.5 führen voraussichtlich zu Fehlern. gtx-cli‑Versionen vor 2.1.5 führen voraussichtlich zu Fehlern.


Motivation

Um die Developer Experience zu verbessern, künftige Entwicklungen zu erleichtern und die Verwaltung von Übersetzungen zu vereinfachen, führen wir Branching ein und stellen einige API-Endpunkte ein, die nicht mehr verwendet wurden.


Funktionen

Die neuesten API-Funktionen unterstützen Branching, sodass du unterschiedliche Übersetzungen für verschiedene Branches deines Projekts erstellen kannst.

Jede Datei ist jetzt einem Branch zugeordnet. Die Dateiversionierung wird nun über branchId, fileId und versionId bestimmt.

Früher waren Dateiübersetzungen nur mit einem einzelnen Branch verknüpft. Zwischengespeicherte Dateiübersetzungen verwendeten standardmäßig die zuletzt aktualisierte Version der Datei.

In Version 8 wird beim Aktualisieren der Übersetzungen einer Datei nun die neueste Version der Datei auf dem angegebenen Branch verwendet. Die Versionierung ist an die Historie eines Branches gebunden, nicht an einen Zeitstempel.

Das neue Versionierungssystem orientiert sich am Branching-Modell von Git:

  • Das Aktualisieren einer Quelldatei auf einem Branch erstellt eine neue Version der Datei.
  • Das Mergen eines Branches in main erzeugt eine Verknüpfung zwischen der Quelldatei auf dem main-Branch und der Quelldatei auf dem gemergten Branch.
    • Zukünftige Übersetzungen berücksichtigen Übersetzungen aus beiden Branches.
  • Das Auschecken eines Branches erstellt eine neue Version der Datei
    • Übersetzungen auf diesem Branch greifen auf frühere Übersetzungen vom main-Branch zurück.

Um diese Funktion zu aktivieren, füge das Flag --enable-branching zum Befehl gtx-cli translate in der neuesten Version von gtx-cli hinzu.

Standardmäßig ist Branching deaktiviert und alle Projektdateien sind dem main-Branch zugeordnet.

Um diese Funktion zu nutzen, muss deine Organisation einen kostenpflichtigen Plan haben.

Änderungen

generaltranslation

  • checkTranslationStatus veraltet
  • downloadFile veraltet
  • downloadTranslatedFile in downloadFile umbenannt
    • Je nachdem, ob eine Locale angegeben ist, wird entweder die Quelldatei oder die entsprechende Übersetzung heruntergeladen
  • Parameter von downloadFile und downloadFileBatch geändert
  • enqueueEntries veraltet
  • Parameter von enqueueFiles geändert (branchIds hinzugefügt)
  • fetchTranslations veraltet
  • shouldSetupProject veraltet
  • Parameter von submitUserEditDiffs geändert (branchIds hinzugefügt, ID-Felder sind jetzt erforderlich)
  • Parameter von uploadSourceFiles geändert (branchIds hinzugefügt)
  • Parameter von uploadTranslations geändert (branchIds hinzugefügt)
  • Parameter von querySourceFile geändert (branchIds hinzugefügt)
  • checkJobStatus hinzugefügt
  • queryFileData hinzugefügt
  • checkSetupStatus veraltet (stattdessen checkJobStatus verwenden)
  • checkFileTranslations veraltet (stattdessen queryFileData verwenden)

gtx-cli

  • Flag --enable-branching zum Befehl translate hinzugefügt
  • Flag --branch zum Befehl translate hinzugefügt
    • (Optional) Überschreibt den Branch, der für die Übersetzung verwendet wird
  • Flag --disable-branch-detection zum Befehl translate hinzugefügt
    • (Optional) Wenn aktiviert, versucht die CLI nicht automatisch, zu verwendende Branches zu erkennen.
    • Verwende dieses Flag, wenn git nicht installiert ist oder wenn das Projekt kein Git-Repository ist.
  • Fortschrittsverfolgung und Protokollierung bei Übersetzungen verbessert
  • Fehlerbehandlung bei Übersetzungen verbessert
  • API-Performance optimiert, um unnötige Datei-Uploads zur API zu vermeiden

gt-sanity

  • Aktualisiert, um die neueste Version von generaltranslation zu verwenden
  • Übersetzungen verwenden standardmäßig den main-Branch.
    • Unterstützung für Branches bei der Vorschau von Dokumententwürfen wird in einer zukünftigen Version hinzugefügt.