Repository navigation
Conversation
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
hlenke
left a comment
There was a problem hiding this comment.
Ready to merge · The new prerequisite is accurate for checkly rca run: the API routes that trigger an analysis require the account's Rocky AI opt-in, and only the Owner role can switch it on. One optional suggestion scopes it to run, because checkly rca get works without the opt-in.
Merge readiness
- CI: all checks pass (docs-gate, preview-checks, static-docs-checks, Mintlify link-rot and vale).
- Mergeable, state
CLEAN.mainhas not touchedcli/checkly-rca.mdxsince the merge basee905ff08. - Overlap: the draft #774 (casing sweep) also edits
cli/checkly-rca.mdx, on other lines. Either order works; this one-line PR can go first. - The link matches the form
mainalready uses for this settings page (https://app.checklyhq.com/accounts/rocky-aiinai/rocky-ai.mdx,resolve/ai-root-cause-analysis/overview.mdx,resolve/automatic-check-repair.mdx), and it agrees withresolve/ai-root-cause-analysis/overview.mdx:29, which already asks readers to enable Rocky AI before using RCA.
Inline comments: 1 Wording (optional).
What I checked
- Read the diff from merge base
e905ff08and the full PR version ofcli/checkly-rca.mdx. gh pr checks 788,gh pr view 788 --json mergeable,mergeStateStatus,gh pr list --json number,files,git log e905ff08..origin/main -- cli/checkly-rca.mdx(no commits).- monorepo
origin/main@d9aff4a355: inapps/backend/api/src/modules/public-api/rocky-ai/routes.ts, the two routes that trigger an analysis (POST /v1/root-cause-analyses/error-groups/{id}and.../test-session-error-groups/{id}) require the account's Rocky AI opt-in feature, andGET /v1/root-cause-analyses/{id}requires only the read permission.packages/models/src/feature-flags/flags.tsdescribes that feature as the account-level Rocky AI opt-in. The backend role-permission snapshot grantsaccount:update-ai-opt-into OWNER only, andAccountsController.tsenforces it when the feature is toggled. Inapps/webapp/src/pages/rocky-ai/PageRockyAiList.vuethe toggle is labeled Enable Rocky AI (i18n/en.ts) and sits behind that permission; the breadcrumb names the page "Rocky AI settings". - checkly/checkly-cli#1593 (open):
rca runnow reports the API'sERR_ROCKY_AI_DISABLED403 and points to the same settings page. As the description says, the docs change does not depend on it. admin/team-management/permissions.mdx:288already listsaccount:update-ai-opt-in.- End-to-end tests: not run. The PR adds no runnable sample, and the claim depends on account feature state, which the backend source settles.
| - Checkly CLI installed | ||
| - Valid Checkly account authentication (run `npx checkly login` if needed) | ||
| - A Checkly plan that includes root cause analysis | ||
| - Rocky AI enabled for the account (an account owner turns it on in the [Rocky AI settings](https://app.checklyhq.com/accounts/rocky-ai)) |
There was a problem hiding this comment.
Wording (optional) · Only the routes that trigger an analysis require the opt-in. GET /v1/root-cause-analyses/{id}, which checkly rca get calls, checks only the read permission, so readers can still fetch existing analyses with Rocky AI off. This version scopes the item to run, drops the parenthetical, capitalizes the role (editing rules: Owner, Admin), and names the toggle:
| - Rocky AI enabled for the account (an account owner turns it on in the [Rocky AI settings](https://app.checklyhq.com/accounts/rocky-ai)) | |
| - Rocky AI enabled for the account, to run new analyses with `checkly rca run`. An account Owner turns on **Enable Rocky AI** in the [Rocky AI settings](https://app.checklyhq.com/accounts/rocky-ai). |
Linear: RED-1380
Affected Components
Notes for the Reviewer
checkly rca runfails when Rocky AI is switched off for the account, but thecheckly rcapage didn't list it as a prerequisite. This adds it, with the note that an account owner turns it on in the Rocky AI settings.Related: checkly/checkly-cli#1593 (the CLI now names this cause in its error). Independent of it; can merge any time.
🤖 Generated with Claude Code