docs: narrow the customer review queue to unanswered escalations - #109
Open
NikitaVr wants to merge 1 commit into
Open
docs: narrow the customer review queue to unanswered escalations#109NikitaVr wants to merge 1 commit into
NikitaVr wants to merge 1 commit into
Conversation
chainpatrol/chainpatrol-web#7452 fixes `needsCustomerReview` so it means
"waiting on you" rather than "yours". Two claims on these pages are now wrong:
Reports an organization submitted itself are no longer in its review queue.
ChainPatrol triages those and staff approval blocks the asset on its own, so
nothing was ever waiting on the customer — listing them asked for a decision
that was never required. They are still returned by
`GET /organization/reports`; only the `needsCustomerReview` filter narrowed.
Consequently `POST /organization/proposals/{proposalId}/review` refuses a
proposal on a self-submitted report with `403`, which the error section now
shows alongside the safety-check `403` it already documented.
Also documents two things the pages never stated: escalating a proposal back to
ChainPatrol counts as answering it (and a later re-escalation returns it to the
queue), and Obligatory Organization Admin Approval does not by itself put a
proposal in the queue.
Contributor
|
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.
Description
Follows chainpatrol/chainpatrol-web#7452, which fixes
needsCustomerReviewso itmeans "waiting on you" rather than "yours". A customer filed a test report, saw
it come back as needing their review, and asked what the filter actually means —
these pages were part of the confusion, because they described the old behavior
accurately.
external-api/organization-proposals-review.mdxreviewable here. A callout states the new rule and, more importantly, why:
ChainPatrol triages self-submitted reports and staff approval blocks the asset
on its own, so submitting the report is already the organization's intent and
there is no second decision to record.
403section now shows the "not waiting on your organization" error nextto the safety-check
403it already documented, with the three ways to hit it(never escalated, already answered, self-submitted).
ChainPatrol (with a later re-escalation returning the proposal to the queue),
and Obligatory Organization Admin Approval does not by itself put a proposal in
the queue.
external-api/organization-reports-list.mdxneedsCustomerReviewrow spells out what qualifies, what counts asanswering, and the two things that do not put a report in the queue.
ChainPatrol staff and are still returned unfiltered — the distinction between
"I can see it" and "I have to act on it" is what the customer was missing.
Screenshots, Videos (if applicable)
No new assets; prose and one
<Note>callout, matching the components alreadyused on the page.
Additional Notes
Schema-driven fields still come from the live OpenAPI document, so the request
and response tables update themselves once the API change deploys. Only the prose
needed changing here.
Merge order does not matter much, but this reads best merged after
chainpatrol/chainpatrol-web#7452 deploys — until then it describes a
403theAPI does not yet return.
The pre-existing inaccuracies I flagged in #108 are still untouched:
reports[].idis documented asrpt_…when it is a number, and the paginationfield is
nextCursor/totalCountrather thancursor. Still worth their ownpass against the live spec.
Generated by Claude Code
Note
Low Risk
Documentation-only prose changes in two MDX files; no runtime or API code in this PR.
Overview
Updates external API docs so the customer review queue matches the fixed
needsCustomerReviewbehavior: only proposals ChainPatrol escalated to you that you haven’t answered count as “waiting on you,” not every proposal tied to your org’s reports.On
organization-proposals-review, the overview drops the idea that self-submitted reports are reviewable via this endpoint. A Note explains self-submitted proposals return403(ChainPatrol triages them; submitting the report is already your intent). The403section adds the “not waiting on your organization” error and when it applies. New Notes clarify that answering includes escalating back to ChainPatrol (re-escalation can put the proposal back in the queue) and that Obligatory Organization Admin Approval alone doesn’t put a proposal in the queue.On
organization-reports-list, theneedsCustomerReviewparameter description and the “awaiting your review” example spell out qualification rules, what counts as answering, and that self-submitted reports stay visible in unfiltered listings but don’t appear under this filter.Reviewed by Cursor Bugbot for commit b532ad6. Bugbot is set up for automated code reviews on this repo. Configure here.