Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename fetch flags #1063

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Rename fetch flags #1063

merged 1 commit into from
Oct 24, 2023

Conversation

jonsnyder
Copy link
Contributor

Description

As recommended by Erik Wiener:

I see the use of "notification" to refer to proposition interactions or events in the docs and in the code, e.g. sendDisplayNotifications and includePendingDisplayNotifications. I personally think it would be better to avoid the term "notification", which is a Target concept, and instead try to align around "proposition", "proposition interaction", and "event", which are solution-agnostic terms. Those two new parameters above stick out to me because I don't think we've tended to use the term "notification" in public docs related to personalization (though I could be wrong). I feel it would be more consistent to use names like sendDisplayEvent and includeRenderedPropositions.

I think of the whole event as the notification, and the proposition interactions inside _experience.decisioning.propositions as the experiences that are the subject of the event (i.e. what personalization experiences were interacted with as part of that event).

Related Issue

Motivation and Context

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Improvement (non-breaking change which does not add functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • I have signed the Adobe Open Source CLA or I'm an Adobe employee.
  • I have made any necessary test changes and all tests pass.
  • I have run the Sandbox successfully.

Copy link
Contributor

@jfkhoury jfkhoury left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love this change! Do we need to update anything in the docs?

@jonsnyder jonsnyder merged commit 731fb16 into main Oct 24, 2023
2 of 3 checks passed
@jonsnyder jonsnyder deleted the renameFetchFlags branch October 24, 2023 14:47
@jonsnyder jonsnyder added the ignore-for-release Do not include this PR in release notes label Nov 1, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ignore-for-release Do not include this PR in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants