LG-13289: Document parameters for verify proofing results event#10849
Merged
LG-13289: Document parameters for verify proofing results event#10849
Conversation
[skip changelog]
matthinz
force-pushed
the
matthinz/13289-verify-proofing-results-docs
branch
from
e91ea68 to
6bf5a4d
Compare
matthinz
commented
Jun 21, 2024
matthinz
force-pushed
the
matthinz/13289-verify-proofing-results-docs
branch
from
a70d0cc to
018a219
Compare
| # @option proofing_results [Hash] context.stages.threatmetrix.response_body JSON body of the response returned from the vendor. PII has been redacted. | ||
| # @option proofing_results [String] context.stages.threatmetrix.response_body.account_lex_id LexID associated with the response. | ||
| # @option proofing_results [String] context.stages.threatmetrix.response_body.session_id Session ID associated with the response. | ||
| # @option proofing_results [String] context.stages.threatmetrix.review_status One of "pass", "review", "reject". |
Contributor
There was a problem hiding this comment.
WDYT of trying to update https://github.com/18F/identity-idp/blob/main/spec/support/fake_analytics.rb#L73 to work with nested hashes/analytics like this?
Contributor
Author
There was a problem hiding this comment.
I don't think I understand that code enough to do it in this PR. Honestly, it starts to feel to me like we need a typechecker. I kind of wonder if it would be preferable to log flat, un-nested structures?
Contributor
There was a problem hiding this comment.
At that point we should switch to Crystal!
zachmargolis
approved these changes
Jun 24, 2024
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
2 participants
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.
🎫 Ticket
Link to the relevant ticket:
LG-13289
🛠 Summary of changes
This PR documents parameters for
IdV: doc auth verify proofing results, Team Ada's "workhorse" analytics event. The structure logged here is deep, with the most important stuff being inproofing_results.context.stages.*.