fix(cli): state the 100-row server cap in alert/alert-event --limit flag help - #138
Merged
Conversation
…lag help The alert list and alert-event list endpoints reject limit > 100 with InvalidParameter. incident list already documents the cap in its --limit flag help; mirror the same wording so the Flags section alone is enough to get the first call right (the long description mentions the cap, but --help readers who grep Flags never see it).
Same shared page-query validator as alert/alert-event/incident list; same wording.
Contributor
Author
|
Extended to |
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.
The alert list and alert-event list endpoints reject
limit > 100withInvalidParameter: Limit must be 100 or less.incident listalready documents the cap in its--limitflag help ("Max results (max 100)"); this mirrors the same wording onto the two alert verbs.Rationale: the cap is mentioned in
alert list's long description, but a reader (human or agent) who greps the Flags section of--helpnever sees it and only discovers the cap by hitting the 400. The flag-level note makes the first call correct.Verification:
make+go test ./internal/...green; built binary shows--limit int Max results (max 100)for both verbs;make gen-cardsproduces no card diff (flag usage strings are not embedded in the generated fences).