Update API names to align with new naming convention (2025-10)#4067
Draft
Update API names to align with new naming convention (2025-10)#4067
Conversation
rennyG
added
the
#gsd:49303
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
As part of the Shopify Dev Docs UI Extension Reference Docs Quality & Completeness GSD project, API names in ui-extensions need to match the naming convention approved for the IA. Source of truth for these changes is in checkout-web: https://github.com/shop/world/pull/483612
Solution
Updates the
namefield in 24*.doc.tsfiles underpackages/ui-extensions/docs/surfaces/checkout/reference/apis/. This is a targeted change directly in this version branch since the porting script from checkout-web is not appropriate for backporting to older versions.🎩
Checklist