Repository navigation
Align subscription migration failure reason types and schema - #8930
Open
kevin-johnson-shopify wants to merge 1 commit into
Open
kevin-johnson-shopify wants to merge 1 commit into
kevin-johnson-shopify wants to merge 1 commit into
Conversation
tyler-eon
approved these changes
Oct 16, 2026
This branch has not been deployed
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
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.
WHY are these changes introduced?
Subscription migration readbacks can report
PLAN_REQUIREMENTS_NOT_METandSHOP_FEATURES_UNVERIFIED, but the CLI's failure-reason type and documented known values omit them. Developers inspecting the JSON schema therefore see an incomplete list.WHAT is this pull request doing?
Add both values to the internal type and the JSON schema description, and regenerate the command manifest and README. Keep upstream values as nullable strings so future API additions continue to pass through JSON and CSV output.
Validation: 61 existing migration tests passed, including API projection, JSON/CSV output and command integration with mocked services. The CLI build, app typecheck, changed-file ESLint and command snapshot check passed. The emitted
--json-schemaincludes both values and retains its nullable string type. Live provider integration was not exercised.How to manually test your changes?
Run
pnpm shopify app subscription-migrations list --json-schemafrom the repository root. Inspectdefinitions.Result.properties.subscriptions.items.properties.lastFailureReason: its description should list both new values, and its type should remain["string", "null"]. This command requires no linked app or API request.Checklist
patchfor bug fixes ·minorfor new features ·majorfor breaking changes) and added a changeset