Änderungslog

In diesem Änderungsprotokoll sind wichtige Änderungen für die API-Designanleitung aufgeführt.

2021-09

• Google API-Fehlerformate v1 und v2 dokumentiert.

2021-04

• Versionsbasierte Versionsverwaltung eingeführt.

• API-Titel im Glossar eingeführt.

2021-03

• Annotation für reine Ausgabefelder hinzugefügt.

• Anleitung zu Enum-Werten wurde aktualisiert, damit immer ein expliziter _UNSPECIFIED-Wert angegeben wird.

• Anleitung zum Generieren und Parsen von Ressourcennamen hinzugefügt.

• progress_percent wurde zu Standardfeldern hinzugefügt.

2021-02

• Anleitung für optional einfache proto3-Felder hinzugefügt.

2021-01

• Seite "Fehler" mit der neuesten Verbesserung in Bezug auf google.rpc.ErrorInfo und google.api.ErrorReason aktualisiert.

• Anleitung zur Verwendung von oauth2l, curl und Systemparametern zur Behebung von Fehlern bei Google APIs hinzugefügt.

• Erläuterung zum Fehlercode 502 zur Seite "Fehler" hinzugefügt. Dies ist ein Netzwerk- und kein API-Fehler.

2020-12

• Paketnamen müssen für eine globale Konsistenz durch einen einzigen Komponentennamen angegeben werden. Paketnamen dürfen keine Unterstriche enthalten.

2020-09

• Einige Anforderungen an Feldbeschreibungen wurden bereinigt. Die Verwendung von „muss“ außerhalb von RFC 2119 wurde zu „sollte“-Anweisungen in RFC 2119 geändert.

• Das Standardfeld bool deleted wurde zugunsten von google.protobuf.Timestamp delete_time (bisher bereits aufgeführt) entfernt.

2020-07

• Die Datei documentation.md wurde aktualisiert und entspricht https://google.aip.dev/192#formatting. Markdown-Tabellen und Raw-HTML dürfen in Proto-Kommentaren nicht verwendet werden.

• ErrorInfo zur Fehlerbehandlung hinzugefügt.

• Große Nutzlasten für Designmuster wurden hinzugefügt.

2020-04

• Cloud-APIs wurden im Glossar in Google Cloud-APIs umbenannt.
• API und Dienst wurden als Synonyme für API-Dienst eingeführt.

2020-02

• Die Versionierung wurde aktualisiert, um zwei Versionsstrategien (auf Kanalebene und Releaseebene) hinzuzufügen, Anleitungen zu Punktversionen zu entfernen und die Bezugnahme auf die semantische Versionierung zu ändern.

2020-01

• Datenaufbewahrung zu Entwurfsmuster wurden hinzugefügt.

2019-11

• Terminologie-Cloud-APIs wurde zum Glossar hinzugefügt.
• Clientsempfehlung zur Wiederholung nur bei nicht verfügbaren Fehlern wurden festgelegt.

2019-06

• "Bool vs Enum vs String" wurde hinzugefügt, um Muster zu entwerfen.

2019-03

• Standardfeldern wurden Systemparameter hinzugefügt

2019-02

• Domainbereichsnamen wurden dem Designmustern hinzugefügt

2018-03

• Halbgeschlossenes Streaming wurde den Designmustern hinzugefügt.

2018-02

• read_time wurde zu Standardfeldern hinzugefügt.

2018-01

• Schemareferenz für API-Dienstdefinition wurde hinzugefügt.

2017-12

• Es wurde klargestellt, dass die API-Hauptversion die letzte Komponente des Proto-Paketnamens sein muss.

2017-11

• Es wurde klargestellt, warum die Methode Create eine Eingaberessource verwendet.
• Es wurde klargestellt, dass es Sammlungs-IDs gibt, die keine Pluralform haben, z. B. "Beweismittel" oder "Wetter".
• Es wurden Singleton-Ressourcen zu Designmustern hinzugefügt.
• Es wurden die C#-Namenskonventionen für Akronyme und Versionen geklärt.

2017-09

• mime_type wurde zu Standardfeldern hinzugefügt.
• expire_time wurde zu Standardfeldern hinzugefügt.
• start_time und end_time wurden zu Standardfeldern hinzugefügt.

2017-02

• "API-Endpunkt" wurde zum Glossar hinzugefügt.
• update_mask wurde zu Standardfeldern hinzugefügt.
• Link zu FieldMask wurde zu Standardmethoden hinzugefügt.
• Es wurde darauf hingewiesen, dass die OpenAPI-Spezifikation keine Ganzzahlen ohne Vorzeichen unterstützt.
• Es wurde klargestellt, dass Verben in Methodennamen im Imperativ verwendet werden müssen.