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

Fix empty bulkCartUpdate typing in docs #2634

Merged
merged 1 commit into from
Feb 13, 2025
Merged

Conversation

vctrchu
Copy link
Contributor

@vctrchu vctrchu commented Feb 12, 2025

Resolves https://github.com/Shopify/shopify-dev/issues/53252

Background

The omit operators don't play well when generating dev docs. I will update the type to exclude the variables instead. Since the docs are evaluated based on the interfaces, they are no generated json file diffs. I ran npm run docs:point-of-sale to be sure.

https://shopify-dev.ui-extensions-pp9g.victor-chu.us.spin.dev/docs/api/pos-ui-extensions/unstable/apis/cart-api#cartapi-propertydetail-bulkcartupdate

Before
Screenshot 2025-02-12 at 12 59 18 PM

After
Screenshot 2025-02-12 at 1 14 51 PM

@vctrchu vctrchu self-assigned this Feb 12, 2025
Copy link
Contributor

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

Copy link
Contributor

@NathanJolly NathanJolly left a comment

Choose a reason for hiding this comment

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

Can you lodge this as a bug with the team that makes the doc generation tooling?

@vctrchu
Copy link
Contributor Author

vctrchu commented Feb 13, 2025

@NathanJolly

Can you lodge this as a bug with the team that makes the doc generation tooling?

Yes, I'll reach out to them to notify them of the issue

@vctrchu vctrchu merged commit 15f984e into unstable Feb 13, 2025
6 checks passed
@vctrchu vctrchu deleted the vic/fix-bulkcartupdate-doc branch February 13, 2025 22:18
@vctrchu
Copy link
Contributor Author

vctrchu commented Feb 13, 2025

@stefanvermaas
Copy link

Just to add to this, it would be great to get some examples for creating, editing, and deleting these cart items in bulk, too. With this PR, the docs are added, but it's still not clear how to use them and what the use cases are.

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