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

Update CustomerSegmentTemplate prop names #1274

Merged

Conversation

PrescilliaA
Copy link
Contributor

@PrescilliaA PrescilliaA commented Aug 22, 2023

Background

We are cleaning up the CustomerSegmentTemplate prop names to make them more stream lined before we expose the API to partners.

Solution

Renaming the following props:

  • templateQuery -> query
  • templateQueryInsert -> queryInsert
  • dateAdded -> createdOn

Marking the previous as deprecated until we add support for the new props in web and in our 1P application: segmentation-templates-app.

Checklist

  • I have 🎩'd these changes
  • I have updated relevant documentation

@PrescilliaA PrescilliaA force-pushed the pa/cleanup-customer-segmentat-template-prop-names branch from 804f231 to e8105c5 Compare August 22, 2023 14:28
@@ -11,17 +11,23 @@ export interface CustomerSegmentTemplateProps {
title: string;
/* Localized description(s) of the template. */
description: string | string[];
/* Code snippet to render in the template with syntax highlighting. */
/* DEPRECATED - Code snippet to render in the template with syntax highlighting. */
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you know how long we should keep the deprecated props before removing them?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Just until the changes are made in the segmentation templates app and the admin. Since no other parties are using our APIs we don't need to respect the deprecation cycle.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I just wanted it to be clear while we make the transition :)

Copy link
Contributor

@lauramann lauramann left a comment

Choose a reason for hiding this comment

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

LGTM!

@PrescilliaA PrescilliaA force-pushed the pa/cleanup-customer-segmentat-template-prop-names branch from e8105c5 to e198e10 Compare August 22, 2023 18:01
Copy link
Contributor

@LTiger14 LTiger14 left a comment

Choose a reason for hiding this comment

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

LGTM!

@PrescilliaA PrescilliaA merged commit 402776a into unstable Aug 23, 2023
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants