Skip to content

Enrich JSDoc for Checkout APIs property descriptions, 2026-04-rc#4232

Draft
rennyG wants to merge 4 commits into2026-04-rcfrom
update-checkout-api-jsdoc-descriptions-2026-04-rc
Draft

Enrich JSDoc for Checkout APIs property descriptions, 2026-04-rc#4232
rennyG wants to merge 4 commits into2026-04-rcfrom
update-checkout-api-jsdoc-descriptions-2026-04-rc

Conversation

@rennyG
Copy link
Copy Markdown
Contributor

@rennyG rennyG commented Mar 27, 2026 •
edited
Loading

Partially closes https://github.com/shop/issues-learn/issues/1047

Summary

  • Ports enriched JSDoc descriptions from checkout-web (shop/world#548830) to ui-extensions 2026-04-rc
  • Covers all 16 Checkout APIs across 10 files: shared types, StandardApi, CheckoutApi, OrderConfirmationApi, CartLineItemApi, ShippingOptionItemApi, ShippingOptionListApi, PickupLocationItemApi, PickupLocationListApi, PickupPointListApi
  • Every description verified against the 2026-04-rc TypeScript types
  • Follows Shopify style guide: contractions, no Latinisms, present tense, colon bullet format for enums

Test plan

  • yarn tsc --noEmit passes
  • yarn docs:checkout 2026-04-rc generates successfully
  • Verify enriched descriptions appear correctly in shopify-dev docs preview

🤖 Generated with Claude Code

@rennyG @claude
Enrich JSDoc for Checkout APIs property descriptions
d2242f7 
Port enriched JSDoc descriptions from checkout-web (shop/world#548830) to
ui-extensions 2026-04-rc. Covers all 16 Checkout APIs across 10 files:
shared types, StandardApi, CheckoutApi, OrderConfirmationApi, cart line,
shipping option, pickup location, and pickup point APIs.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 27, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

@rennyG rennyG changed the title Enrich JSDoc for Checkout APIs property descriptions Enrich JSDoc for Checkout APIs property descriptions, 2026-04-rc Mar 27, 2026
@rennyG rennyG self-assigned this Mar 27, 2026
@rennyG rennyG added the #gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness label Mar 27, 2026
rennyG and others added 3 commits March 27, 2026 16:04
@rennyG @claude
Fix VisitorConsent.saleOfData description (inverted semantics)
05bb381 
The boolean represents consent granted, not opt-out. Align with the
corrected checkout-web description.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@rennyG @claude
Update JSDoc from latest checkout-web review changes
7745d67 
Re-apply the full checkout-web diff after review feedback. Includes
updated descriptions for localizedFields, applyTrackingConsentChange,
and other refinements from PR review.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@rennyG @claude
Update JSDoc from latest checkout-web review changes
78cfbb9 
Re-apply full checkout-web diff with review feedback. Includes
{API_VERSION} placeholder URLs, updated descriptions, and Shopify
Function link fixes. All fully qualified URLs preserved.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@rennyG rennyG

Labels

#gsd:49303 Shopify Dev Docs: UI Extension Reference Docs: Quality & Completeness

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@rennyG