Update from code changes: expand CLI section on proposal review reference - #111
Open
mintlify[bot] wants to merge 1 commit into
Open
Update from code changes: expand CLI section on proposal review reference#111mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
Expand the CLI section on the organization proposal review API reference so the read + write flow composes end-to-end from the terminal.
Changes
chainpatrol proposals reviewflag alongside the existingreports list --needs-customer-reviewexample.--json, and--no-inputwithout--yes.OTHER, and dry-run.Context
proposals[].idon the reports listing,reviewOrganizationProposalSDK method).chainpatrol proposals reviewsubcommand.The API reference page, the reports listing note about
proposals[].id, and the SDK types were already documented — only the CLI walkthrough was thin, so this pass fills that gap.Note
Low Risk
Documentation-only changes to an external API reference page; no runtime or API behavior is modified.
Overview
Expands the From the CLI section on the organization proposal review API reference so the list-then-review flow is documented end-to-end from the terminal.
The intro now names
chainpatrol proposals reviewand ties it tochainpatrol reports list --needs-customer-review. New Options table documents every flag (--asset-id,--decision, label/brand/reject/watchlist fields,--org,--yes,--dry-run). Confirmation explains interactive prompts,--yes, refusal with exit code3when--json,--no-input, or non-TTY stdin is used without--yes, and--dry-run. Examples cover approve, brand-required approve, reject, watchlist withOTHER, and dry-run.Reviewed by Cursor Bugbot for commit 1fe60be. Bugbot is set up for automated code reviews on this repo. Configure here.