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

Add discount functions settings api docs #2534

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

devisscher
Copy link
Contributor

@devisscher devisscher commented Dec 16, 2024

Background

This PR adds a section for Discount Function Settings API, similar to the Validation Settings API.

Related PR: https://github.com/Shopify/web/pull/151973

Solution

Adding the interface and data provided to the extension point.

🎩

Spin Link

For info on how to setup docs: https://app-ui.docs.shopify.io/guides/documentation/ui-extensions

  1. Go to Discount Function Settings API and review content.

Checklist

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

@devisscher devisscher requested a review from iphipps December 16, 2024 17:53
@devisscher devisscher marked this pull request as ready for review December 16, 2024 17:55

This comment has been minimized.

@devisscher devisscher requested a review from a team December 16, 2024 18:01
@devisscher devisscher self-assigned this Dec 17, 2024
Copy link

@iphipps iphipps left a comment

Choose a reason for hiding this comment

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

looks good. Do you also need to generate the docs and pr on shopify-dev?

Copy link
Contributor

@MitchLillie MitchLillie left a comment

Choose a reason for hiding this comment

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

Hey Tom. You will need to add a changeset (yarn changeset, pick minor, commit the resulting file).

As Ian mentioned, after this is merged you will need to regenerate the docs and create a PR on shopify-dev

@@ -0,0 +1,76 @@
const supportedDefinitionTypes = [
Copy link
Contributor

Choose a reason for hiding this comment

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

Does this need to be a const? I feel it might be ideal to keep this as a type to avoid increasing the runtime size of the library.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated and moved the SupportedDefinitionTypes to shared since they are used in Validation Settings as well.

@devisscher devisscher force-pushed the discount-function-settings-api branch 2 times, most recently from cad2834 to 68510ff Compare December 18, 2024 14:24
@devisscher
Copy link
Contributor Author

Hey Tom. You will need to add a changeset (yarn changeset, pick minor, commit the resulting file).

As Ian mentioned, after this is merged you will need to regenerate the docs and create a PR on shopify-dev

@MitchLillie I added the changeset.

@devisscher devisscher force-pushed the discount-function-settings-api branch from 5c9af98 to 1248670 Compare December 18, 2024 14:27
@devisscher devisscher merged commit 1faa963 into unstable Dec 18, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants