Review commands: publish, remove, withhold
The Review Verbs publish, remove, withhold as CLI commands, with inputs, result, refusals and an example.
Reference for Review, one group of Review commands.
Review.publish
Publish shows a Review on the Startup’s Pages with its rating counted, whatever the rating. Verb page.
npx startup-builder do Review.publish --json '<input>' [--try | --send | --do]Emits Review.published.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review to show. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review, now published. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Review.publish --json '{"review":Review.remove
Remove takes a Review down for good when its author or its venue asks; the record is kept. Verb page.
npx startup-builder do Review.remove --json '<input>' [--try | --send | --do]Emits Review.removed.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review to take down. |
reason | string | required | Who asked. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review, now removed. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Review.remove --json '{"review":Review.withhold
Withhold keeps a Review off display for one of five reasons, none of them its rating or its tone. Verb page.
npx startup-builder do Review.withhold --json '<input>' [--try | --send | --do]Emits Review.withheld.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review to withhold. |
reason | string | required | Why it is not shown. |
Returns
| Output | Type | Required | Description |
|---|---|---|---|
review | Review | required | The Review, now withheld. |
Refuses when
| Check | Error | Fix | Then call |
|---|---|---|---|
| The key is valid, but its scopes do not allow this operation. | forbidden | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |
Example
npx startup-builder do Review.withhold --json '{"review":