docs(cronjob): document KAS mail_address/mail_adress fixture echo (closes #168)#192
Merged
Merged
Conversation
… typo in fixtures The three echo-bearing cronjob response fixtures (add success + warning, update success) now carry a top-of-file XML comment explaining that KAS itself echoes the notification address under "mail_address" (double d) in the KasRequestParams block, while the documented request key — and the one the read/write mapping uses — is "mail_adress" (single d). The mapping never reads the echo, so the captured payload is preserved verbatim instead of being normalised. Closes the last code Nice-to-have from #168.
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
1 participant
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.
Summary
Final code item of the #168 nice-to-have bundle. The three echo-bearing cronjob response fixtures (
addsuccess + warning,updatesuccess) now carry a top-of-file XML comment explaining KAS's own request/response key inconsistency:mail_adress(single d).KasRequestParamsecho:mail_address(double d).The mapping code never reads the echo block, so the captured fixture data is preserved verbatim rather than normalised. The comment removes a future-reader hazard ("is this a typo in our fixture?") without distorting the recording.
Items 6 (
UpdateParamsmap ordering) and 7 (cronjobaddauditTarget = --comment) stay accepted-as-noted per the original review comments.Closes #168.