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

Additional fixes

Browse Source
This commit is contained in:
Juan Manuel Pérez
2024-04-25 12:59:21 +02:00
parent e288b50e1a
commit 92e4a7344a
1 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
asynchronous-api-guidelines/02_asynchronous_api_guidelines/main.md
View File

@@ -68,8 +68,6 @@ As a summary, the available compatibility types are listed below:
|FULL_TRANSITIVE|both backward and forward compatibility with all schema versions| |FULL_TRANSITIVE|both backward and forward compatibility with all schema versions|
|NONE|schema compatibility checks are disabled| |NONE|schema compatibility checks are disabled|
(info) To help visualizing these concepts, consider the flow of compatibility from the perspective of the consumer
#### Backward compatibility #### Backward compatibility
There are two variants here: There are two variants here:
@@ -84,7 +82,7 @@ The operations that preserve backward compatibility are:
- Add optional fields (with default values) - Add optional fields (with default values)
- Consumers will set the default value for the missing fields in their schema version - Consumers will set the default value for the missing fields in their schema version
![sr_backward](../../assets/sr_backward_compatibility.png) ![Backward compatibility](../../assets/sr_backward_compatibility.png)
#### Forward compatibility #### Forward compatibility
@@ -100,7 +98,7 @@ The operations that preserve forward compatibility are:
- Delete optional fields (with default values) - Delete optional fields (with default values)
- Consumers will use the default value for the missing fields defined in their schema version - Consumers will use the default value for the missing fields defined in their schema version
![sr_forward](../../assets/sr_forward_compat.png) ![Forward compatibility](../../assets/sr_forward_compat.png)
#### Full compatibility #### Full compatibility
@@ -117,6 +115,8 @@ This mode is preserved only if using the following operations
- Adding optional fields (with default values) - Adding optional fields (with default values)
- Delete optional fields (with default values) - Delete optional fields (with default values)
![Full compatibility](../../assets/sr_full_compat.png)
#### Upgrading process of clients based on compatibility #### 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.