New test data models documentation #687
Merged
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
|
tdeekens
reviewed
Oct 3, 2024
CarlosCortizasCT
added
the
fe-chapter-rotation
|
|
||
| ## Context | ||
|
|
||
| First of all, remember that a test data model is a set of objects that allows to create objects that mimic commercetools APIs responses which help during testing implementation. |
There was a problem hiding this comment.
Suggested change
| First of all, remember that a test data model is a set of objects that allows to create objects that mimic commercetools APIs responses which help during testing implementation. | |
| First of all, remember that a test data model is a set of objects that allow consumers to create objects that mimic commercetools APIs responses which help during testing implementation. |
There was a problem hiding this comment.
Update here: 1f27b84
| }; | ||
| ``` | ||
|
|
||
| In this example, `name` and `description` are values that are calculated based on the `nameAllLocales` and `descriptionAllLocales`. The latter need to be built first using the `postBuild` function. |
There was a problem hiding this comment.
Suggested change
| In this example, `name` and `description` are values that are calculated based on the `nameAllLocales` and `descriptionAllLocales`. The latter need to be built first using the `postBuild` function. | |
| In this example, `name` and `description` are values that are calculated based on the `nameAllLocales` and `descriptionAllLocales`. The latter need to be built first, then `name` and `description` are built using the `postBuild` function. |
There was a problem hiding this comment.
Hopefully I have the order correct here.
There was a problem hiding this comment.
Updated here: fdafc20
tylermorrisford
approved these changes
Oct 3, 2024
tdeekens
approved these changes
Oct 4, 2024
Sarah4VT
approved these changes
Oct 7, 2024
Comment on lines
155
to
156
| This is an optional and we should only use if there are any dependencies among the data model fields. | ||
| In this case, `name` and `description` depend on the values from `nameAllLocales` and `descriptionAllLocales` but we don't know them in advance but only once the data model has been built. The `postBuild` callback allows to manipulate the built object before it's returned to the consumer. |
There was a problem hiding this comment.
Nit: Small grammatical cleanup.
Suggested change
| This is an optional and we should only use if there are any dependencies among the data model fields. | |
| In this case, `name` and `description` depend on the values from `nameAllLocales` and `descriptionAllLocales` but we don't know them in advance but only once the data model has been built. The `postBuild` callback allows to manipulate the built object before it's returned to the consumer. | |
| This is optional and we should only use it if there are any dependencies among the data model fields. | |
| In this case, `name` and `description` depend on the values from `nameAllLocales` and `descriptionAllLocales`. We won't know the values in advance, but will once the data model has been built. The `postBuild` callback allows us to manipulate the built object before it's returned to the consumer. |
There was a problem hiding this comment.
Thanks for the suggestion, Sarah 🙇
Applied here: 783806a
leventekobor
approved these changes
Oct 8, 2024
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.
This PRs add new documentation to the repository where we explain how new test data models look like and how to build them.