Conversation
There was a problem hiding this comment.
Pull request overview
This PR improves the usability of the basecamp api CLI command by adding concrete, copy/paste-ready examples to the parent api command and each HTTP-verb subcommand, making the raw API interface easier to understand from --help and from machine-mode usage hints.
Changes:
- Add
Exampletext forbasecamp api(parent) to show common GET/POST usage. - Add
Exampletext forbasecamp api get|post|put|deleteto demonstrate paths, full URLs, and JSON payload usage. - Ensure agent/machine-mode
missingArghints can include a meaningful first example line forpost/putwhen--datais missing.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Concrete usage examples surface in --help output and in missingArg/noChanges machine-mode error hints, giving both humans and agents a clear starting point.
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.
Summary
Examplefield to theapiparent command and all four subcommands (get, post, put, delete)--helpoutput and inmissingArg/noChangesmachine-mode error hintsContext
DHH feedback card 9660578055 — the
apicommand was unclear without concrete examples showing what paths and payloads look like.Test plan
bin/cipassesbasecamp api -h/basecamp api get -hshow examplesSummary by cubic
Add concrete examples to the
apicommand and itsget,post,put, anddeletesubcommands. Examples now show common paths, absolute URLs, and-dpayloads in--helpand error hints to make raw API usage clearer.Examplestrings to the parentapicommand and all subcommands.--helpand inmissingArg/noChangesmachine-mode hints.Written for commit 1743834. Summary will update on new commits.