Updated documentation to describe when validators run - #2594
Open
ruthst00 wants to merge 1 commit into
Open
Conversation
…GitHub issue DATAREST-789 Signed-off-by: ruthes00 <ruthes00@gmail.com>
This file contains hidden or 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
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.
Fixes #1161
Solution
The documentation has been updated in two files to resolve GitHub issue DATAREST-789 (#1161):
src/main/antora/modules/ROOT/pages/events.adoc— Added a new "Event Lifecycle and Object State" section that:POST,PUT,PATCH,DELETE, and association resource operationsPATCHbehavior:BeforeSaveEventreceives the already-merged domain object (existing entity + patch applied), not the raw partial inputsrc/main/antora/modules/ROOT/pages/validation.adoc— Added a new "Validation Events and Object State" section that:beforeSave,beforeCreate) to its HTTP trigger and the object state the validator receivesbeforeSavevalidators receive the fully-merged entity for PATCH (not a partial object), with a concrete code example showing it is safe to validate all fieldsbeforeCreateandbeforeSavevalidators