EventsSDK: Document eligible $auto fields #132
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
AjayBenno
previously requested changes
Feb 20, 2024
mtian725
reviewed
Feb 20, 2024
mtian725
reviewed
Feb 26, 2024
mtian725
reviewed
Feb 26, 2024
mtian725
reviewed
Feb 27, 2024
mtian725
reviewed
Feb 27, 2024
mtian725
reviewed
Feb 27, 2024
mtian725
reviewed
Feb 27, 2024
mtian725
reviewed
Feb 27, 2024
mtian725
approved these changes
Feb 28, 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.
The SDK EventPayload does not make it clear if certain fields do not need to be set by the user because they can be automatically inferred when the the value is set to
$auto(which is the default value for several fields).This change adds documentation to the EventPayload so these fields are indicated.
J=FUS-6251
R=abenno, mtian
TEST=manual
Ran
npm run buildto confirm everything is formatted correctly.