Mirrors/api-guidelines
1
0
Fork 0
mirror of https://github.com/adidas/api-guidelines.git synced 2025-10-25 15:19:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

FDP-5206 - Update guidelines and format

Browse Source
This commit is contained in:
Guillermo Lagunas
2025-06-10 16:01:34 +02:00
parent f4486b00b5
commit c587e3e014
15 changed files with 72 additions and 72 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
asynchronous-api-guidelines/kafka-asynchronous-guidelines/f_schema_data_evolution/README.md
View File

@@ -17,9 +17,9 @@ As a summary, the available compatibility types are listed below:
| Mode | Description |
| -------------------- | --------------------------------------------------------------------------- |
| BACKWARD | new schema versions are backward compatible with older versions |
| BACKWARD\_TRANSITIVE | backward compatibility across all schema versions, not just the latest one. |
| BACKWARD\_TRANSITIVE | backward compatibility across all schema versions, not just the latest one |
| FORWARD | new schema versions are compatible with older consumer versions |
| FORWARD\_TRANSITIVE | forward compatibility across all schema versions. |
| FORWARD\_TRANSITIVE | forward compatibility across all schema versions |
| FULL | both backward and forward compatibility with the latest schema version |
| FULL\_TRANSITIVE | both backward and forward compatibility with all schema versions |
| NONE | schema compatibility checks are disabled |
@@ -28,7 +28,7 @@ As a summary, the available compatibility types are listed below:
#### Upgrading process of clients based on compatibility
Depending on the compatibility mode, the process of upgrading producers/consumers will be different based on the compatibility mode enabled.
Depending on the compatibility mode, the process of upgrading producers/consumers will be different based on the compatibility mode enabled:
* NONE
* As there are no compatibility checks, no order will grant a smooth transition

2
asynchronous-api-guidelines/kafka-asynchronous-guidelines/f_schema_data_evolution/full-compatibility.md
View File

@@ -2,7 +2,7 @@
This is a combination of both compatibility types (backward and forward). It also has 2 variants:
* FULL - Backward and forward compatible between schemas X and X - 1.
* FULL - Backward and forward compatible between schemas X and X - 1
* FULL\_TRANSITIVE - Backward and forward compatible between schemas X and all previous ones (X - 1, X - 2, ...)
**Important** Once more, FULL\_TRANSITIVE is the default compatibility mode in adidas, it is set at cluster level and all new schemas will inherit it