CHA-1422: Guide to migrate from Event API to Event Platform #1021
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Gitleaks PR check🟢 We detected no secrets within this PR! Good job 🎉 |
tomglvng
reviewed
Mar 26, 2025
|
|
||
| ## Development adjustments | ||
| ### Product UUID and removal of identifier | ||
| In the previous Event API, you had the option to send product information using either UUID or identifier. With the Event Platform, only the UUID is transmitted. If you were using product identifiers, you will need to transition to using UUIDs. |
There was a problem hiding this comment.
Suggested change
| In the previous Event API, you had the option to send product information using either UUID or identifier. With the Event Platform, only the UUID is transmitted. If you were using product identifiers, you will need to transition to using UUIDs. | |
| In the previous Event API, you had the option to send product information using either UUID or identifier. With the Event Platform, only the UUID is transmitted. If you were using product identifiers, you will need to transition to using UUIDs. |
"transition" is not a verb, so you should change this word. In my opinion, you can remove the sentence. What do you think?
There was a problem hiding this comment.
Are you sure ?
Reverso propose it too. But may be it's better to use "make the transition" ?
There was a problem hiding this comment.
Oh yes, I learnt something!
| This change will not affect product model events. | ||
|
|
||
| ### Differential payload (delta) instead of full payload | ||
| In the old Event API, each event related to an update provided a complete snapshot of the object (simple product, model, or variant), including a wealth of data. With the Event Platform and the `*.updated.delta` events, you will now receive only the data that has changed. The format for these new events is detailed in the documentation [here](https://api.akeneo.com/event-platform/available-events.html). |
There was a problem hiding this comment.
Suggested change
| In the old Event API, each event related to an update provided a complete snapshot of the object (simple product, model, or variant), including a wealth of data. With the Event Platform and the `*.updated.delta` events, you will now receive only the data that has changed. The format for these new events is detailed in the documentation [here](https://api.akeneo.com/event-platform/available-events.html). | |
| In the old Event API, each event related to an update provided a complete snapshot of the object (simple product, model, or variant), including a wealth of data. With the Event Platform and the `*.updated.delta` events, you will now receive only the data that has changed. The format for these new events is detailed in the documentation [here](https://api.akeneo.com/event-platform/available-events.html). |
a wealth of data = ?
There was a problem hiding this comment.
Yes I didn't know this word before the proposal by ChatGPT (It replaced my "a bunch of"). What do you prefer ?
Co-authored-by: Thomas Galvaing <[email protected]>
Co-authored-by: Thomas Galvaing <[email protected]>
Co-authored-by: Thomas Galvaing <[email protected]>
Co-authored-by: Thomas Galvaing <[email protected]>
Co-authored-by: Thomas Galvaing <[email protected]>
tomglvng
approved these changes
Apr 8, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Preview here : https://pr-1021.api-dev.akeneo.com/events-documentation/migrate-to-event-platform.html