יומן שינויים

ביומן השינויים הזה מפורטים שינויים חשובים ב-API Design Guide.

2025-06

• הפנייה של מוסכמת מתן השמות בדף העיצוב אל Google AIP.

2024-10

• הפניות אוטומטיות מדפי עיצוב לממשקי API של Google, למעט מבנה ספרייה ומוסכמות למתן שמות.

2021-12

• שינינו את המונח Networked API ל-Network API כדי לשמור על עקביות עם https://google.aip.dev/9.

2021-09

• תיעוד של פורמט השגיאות של Google API גרסה 1 וגרסה 2.

2021-04

• השקנו ניהול גרסאות על סמך הרשאות גישה.

• הוספנו את המונח 'שם ה-API' למילון המונחים.

2021-03

• הוספנו הערה לשדות פלט בלבד.

• הנחיות לעדכון ערכי enum כך שתמיד יכללו ערך מפורש של _UNSPECIFIED.

• הוספת הנחיות לגבי יצירה וניתוח של שמות משאבים.

• הוספת progress_percent לשדות רגילים.

2021-02

• נוספו הנחיות לגבי שדות פרימיטיביים של proto3 optional.

2021-01

• עדכנו את הדף 'שגיאות' כדי לכלול את השיפורים האחרונים שקשורים ל-google.rpc.ErrorInfo ול-google.api.ErrorReason.

• הוספנו הנחיות לשימוש ב-oauth2l, ב-curl ובפרמטרים של המערכת כדי לפתור שגיאות ב-Google APIs.

• הוספנו הסבר על קוד השגיאה 502 לדף השגיאות. זו שגיאה ברשת ולא שגיאה ב-API.

2020-12

• שמות החבילות צריכים להשתמש בשמות רכיבים ביחיד כדי לשמור על עקביות גלובלית. שמות החבילות לא יכולים לכלול קווים תחתונים.

2020-09

• ניקינו כמה דרישות לתיאור שדות, ושינינו כמה מקרים שבהם השתמשנו במילה must (חובה) מחוץ ל-RFC 2119, כך שיהיו בהתאם להוראות should (רצוי) של RFC 2119.

• הוסר שדה התקן bool deleted לטובת google.protobuf.Timestamp delete_time (שכבר היה רשום).

2020-07

• עדכנתי את הקובץ documentation.md כך שיתאים לכתובת https://google.aip.dev/192#formatting. אסור להשתמש בטבלאות Markdown וב-HTML גולמי בתגובות של פרוטו.

• נוסף ErrorInfo לטיפול בשגיאות.

• נוספו מטענים ייעודיים (payloads) גדולים לדפוסי עיצוב.

2020-04

• שונה השם Cloud APIs ל-Google Cloud APIs במילון המונחים.
• הוספנו את המונחים API ושירות כמילים נרדפות למונח שירות API.

2020-02

• עדכנו את ניהול הגרסאות כדי להוסיף שתי אסטרטגיות לניהול גרסאות (מבוססות-ערוץ ומבוססות-מהדורה), הסרנו את ההנחיות לגבי גרסאות נקודתיות ושינינו את האופן שבו אנחנו מתייחסים לניהול גרסאות סמנטי.

2020-01

• הוספת שמירת נתונים לדפוסי עיצוב.

2019-11

• הוספת מונחים מממשקי Cloud API למילון המונחים.
• מומלץ ללקוחות לנסות שוב רק אם מתקבלות שגיאות UNAVAILABLE.

2019-06

• הוספת 'Bool vs Enum vs String' לדפוסי עיצוב.

2019-03

• להוסיף פרמטרים של המערכת לשדות רגילים.

2019-02

• הוספת שמות בהיקף הדומיין לתבניות עיצוב.

2018-03

• הוספת סמנטיקה של סגירה חלקית של סטרימינג לתבניות עיצוב.

2018-02

• הוספת read_time לשדות רגילים.

2018-01

• הוספת הפניה לסכימה להגדרת שירות API.

2017-12

• הבהרה שגרסה ראשית של API חייבת להיות הרכיב האחרון בשם חבילת ה-proto.

2017-11

• הסבר למה הפונקציה Create מקבלת משאב קלט.
• הבהרה של מזהי אוסף שאין להם צורת רבים, כמו evidence ו-weather.
• הוספת משאב יחיד לתבניות עיצוב.
• הבהרה לגבי מוסכמות למתן שמות ב-C# לראשי תיבות ולגרסאות.

2017-09

• הוספת mime_type לשדות רגילים.
• הוספת expire_time לשדות רגילים.
• הוספת start_time וend_time לשדות רגילים.

2017-02

• הוספת 'נקודת קצה ל-API' למילון המונחים.
• הוספת update_mask לשדות רגילים.
• הוספת קישור ל-FieldMask לשיטות רגילות.
• מציינים שמפרט OpenAPI לא תומך במספרים שלמים לא חתומים.
• הבהרה ששמות של שיטות צריכים לכלול פעלים בציווי.