Conversation
gsa-manish
force-pushed
the
LG-5923-document-analytics-events-5
branch
2 times, most recently
from
759c8c1 to
1c417eb
Compare
app/services/analytics_events.rb
Outdated
There was a problem hiding this comment.
the goal is to try to document what hash fields. Looks like this comes from EmailConfirmationTokenValidator
Looks like these are some of the attributes: https://github.com/18F/identity-idp/blob/main/app/services/email_confirmation_token_validator.rb#L48-L52
There was a problem hiding this comment.
Got it - check now?
gsa-manish
force-pushed
the
LG-5923-document-analytics-events-5
branch
3 times, most recently
from
96df557 to
c6e1e4c
Compare
app/services/analytics_events.rb
Outdated
There was a problem hiding this comment.
now there is no param named result ... can we document any keys we know of for this hash?
There was a problem hiding this comment.
Looks like the callsite was missing **, so I added that in f141033
Also when inspecting locally, found a success: key, so I added that in there too
gsa-manish
force-pushed
the
LG-5923-document-analytics-events-5
branch
2 times, most recently
from
dff6066 to
9baee93
Compare
changelog: Analytics, Yard, Updated banned_user_visited and email_confirmation to use yard
gsa-manish
force-pushed
the
LG-5923-document-analytics-events-5
branch
from
9baee93 to
c9eeb09
Compare
Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com>
| end | ||
|
|
||
| # @identity.idp.event_name Add Email: Email Confirmation | ||
| # @param [Boolean] success |
There was a problem hiding this comment.
Should this have been excluded?
[warn]: @param tag has unknown parameter name: success
in file `app/services/analytics_events.rb' near line 91
| # @param [Boolean] success |
There was a problem hiding this comment.
I should have added it as a kwarg as well as documenting it
3 participants
This is an extension of: #6014
The story is: https://cm-jira.usa.gov/browse/LG-5923
Please note that the events ADD_EMAIL, ADD_EMAIL_CONFIRMATION_RESEND , ADD_EMAIL_VISIT were never utilized so they have been removed from the events list.
The only events that are still there are ADD_EMAIL_CONFIRMATION and BANNED_USER_VISITED