fix: rename share JSON output to appBuildShare with webUrl#183
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the share-related --json output for app build sharing with the repository’s schema and URL naming conventions, standardizing the resource key and the share page URL field name.
Changes:
- Renames the share URL field from
urltowebUrlin share-related outputs. - Renames the nested JSON object in
apps:builds:create --shareoutput fromsharetoappBuildShare. - Documents these conventions in
CLAUDE.mdand updates affected tests.
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/utils/app-build-shares.ts | Renames returned share page URL field to webUrl and preserves QR code URL generation. |
| src/commands/apps/builds/share.ts | Updates --json output and console messaging to use webUrl. |
| src/commands/apps/builds/share.test.ts | Updates assertions to match the new webUrl JSON shape and ordering. |
| src/commands/apps/builds/create.ts | Renames nested JSON output key to appBuildShare and uses webUrl consistently. |
| src/commands/apps/builds/create.test.ts | Updates assertions to match appBuildShare and webUrl output. |
| CLAUDE.md | Adds documented conventions for webUrl naming and nested entity key naming. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
What
Aligns the share-related
--jsonoutput with the schema and URL naming conventions:apps:builds:create --share: theshareobject is renamed toappBuildShare, matching the entity naming used across endpoints and schemas.urltowebUrlin bothapps:builds:createandapps:builds:share, following the commonwebUrlconvention for links pointing to a page in a web UI. Field order:id,qrCodeUrl,webUrl,expiresAt.CLAUDE.md.Note: this changes the JSON output of the recently released sharing commands. It is intentionally published as a fix (no major bump) since the feature has no adoption yet.