docs(tool-executions): fix an invented env var and a wrong host that just merged - #1160
Merged
Merged
Conversation
…d variable The previous commit introduced `$ARCADE_ACCOUNT_TOKEN`, which is not a thing — no such variable exists in the product or anywhere else on this site. The audit log page documents the same org-scoped shape as "User (API key/JWT)" with `$ARCADE_API_KEY`, so that is what this uses, with a pointer to it and a note that a project key is refused. The URL was wrong from the start, in both host and prefix. `logging-config` is a Coordinator route, and every other Coordinator `orgs/` call on this site is `cloud.arcade.dev/api/v1/`; only this page said `api.arcade.dev/v1/`. A live stack returns 404 for `/v1/orgs/...` and resolves `/api/v1/orgs/...`. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
josebarrueta
added a commit
that referenced
this pull request
Aug 31, 2026
* docs: document tool executions in the Operate area Adds a Tool Executions page under Operate > Governance, next to Audit Logs, covering the dashboard surface and read API shipped in ArcadeAI/monorepo#2661 and #2662. The page serves both jobs the feature exists for: a developer debugging why a tool call failed by reading the exact inputs and outputs, and an operator reviewing what a project ran for compliance and usage. It documents the access split those PRs introduced — the history is readable by anyone with a role on the project, while the recorded inputs and outputs take project-admin authority, and diagnostics stay readable either way. Also cross-links the page from the developer-facing tool error handling guide, and adds it to the Governance and Operate card grids. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> * 🤖 Regenerate LLMs.txt * docs(tool-executions): recording and retention are self-service [PLT-2978] (#1141) * docs(tool-executions): recording and retention are self-service The Retention section predates PLT-2978 and told readers to contact support for changes they can now make themselves. It was also wrong in three ways that matter more than the missing capability: - It offered project-level overrides. Project settings are an explicit non-goal; the value is organization-wide and nothing customer-reachable sets a project's own. - It folded turning recording off together with deleting history. They are different: recording off stops new runs being written and leaves stored ones to expire on the window. Shortening the window is the control that deletes, and it reaches records already held. - It gave no bounds, so a reader had no way to know 0 and 400 are refused. Rewritten around the two settings, what each does to history already held, and what a reader sees when the list is empty. * docs(tool-executions): Evan's review — tighter, and no unshipped behaviour Takes the suggested wording for the opening, the table, and the defaults sentence, and types the two settings. Drops four things: the org-admin authority line, which the opening now covers; two connective sentences that only restated the bullets under them; the callout about recording permitting rather than compelling, since project-level settings do not exist and the distinction has no observable effect until they do; and the empty-history section, which narrated UI copy the product already shows. The Callout import goes with its last use. * docs(tool-executions): scope the defaults to Arcade Cloud "By default, recording is enabled" holds for Arcade Cloud, where the organization starts at ALLOWED and projects start enabled. It does not hold for a self-hosted deployment: the Engine's execution_logging.enabled defaults to false, and with it off no run is recorded and no retention worker runs, whatever the organization's policy says. The paragraph two below already scopes the maximum to Arcade Cloud, so this now reads consistently, with one clause for the self-hosted case. * docs(tool-executions): follow the Logging Policy rename, and fix the API credential (#1157) docs(tool-executions): follow the page rename, and name a credential that works The dashboard page is called Logging Policy now, and it sits under Organization, so "open your organization and select Execution Logging" names neither the label nor the path a reader would follow. The curl was worse than stale. It sent `$ARCADE_API_KEY`, which every other sample on the site means as a project key, and this endpoint refuses one: `401 Invalid credentials: missing account ID`. The policy is org-scoped and the route resolves an account, so a project key cannot carry the caller. Verified against a live stack — the same request with an account token returns 200. Everything else on the page was checked against that stack and holds: recording starts ALLOWED, the window starts at 7 with a maximum of 90 reported as `max_log_retention_days`, 0 and 91 are both refused with 422 rather than clamped, and sending one field leaves the other alone. Co-authored-by: Claude Opus 5 <noreply@anthropic.com> * docs(tool-executions): fix an invented env var and a wrong host that just merged (#1160) docs(tool-executions): correct the endpoint host, and drop an invented variable The previous commit introduced `$ARCADE_ACCOUNT_TOKEN`, which is not a thing — no such variable exists in the product or anywhere else on this site. The audit log page documents the same org-scoped shape as "User (API key/JWT)" with `$ARCADE_API_KEY`, so that is what this uses, with a pointer to it and a note that a project key is refused. The URL was wrong from the start, in both host and prefix. `logging-config` is a Coordinator route, and every other Coordinator `orgs/` call on this site is `cloud.arcade.dev/api/v1/`; only this page said `api.arcade.dev/v1/`. A live stack returns 404 for `/v1/orgs/...` and resolves `/api/v1/orgs/...`. Co-authored-by: Claude Opus 5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5 (1M context) <noreply@anthropic.com> Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com> Co-authored-by: Jose Luis Barrueta <jose@arcade.dev>
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
1 participant
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.
#1157 merged ten minutes before its own correction landed.
add-doc-screenshotscurrently carries two errors I introduced; this fixes both.8e7c9a33—$ARCADE_ACCOUNT_TOKEN,api.arcade.dev/v1/...7fba7342— the correction, which missed the mergeWhat is wrong on the branch right now
$ARCADE_ACCOUNT_TOKENdoes not exist. I invented it. It appears nowhere in the product or on this site. A reader would export nothing, get a401, and have no name to look up.The URL is wrong in host and prefix.
logging-configis a control-plane route. Every other one on this site iscloud.arcade.dev/api/v1/; a live stack returns404for/v1/orgs/...and resolves/api/v1/orgs/....What this changes it to
$ARCADE_API_KEYmatches the audit log page, which documents the same org-scoped shape as "User (API key/JWT)". The surviving, verified claim is narrower: a project key is refused with401 Invalid credentials: missing account ID, and the prose now says so.How this happened
I hit that
401while testing with a project key from the fixtures, concluded the documented credential was wrong, and invented a replacement without checking that it existed. The check I skipped was one grep of the sibling page.Worth reviewing this one on the diff rather than the description.
Note
Low Risk
Documentation-only fix for copy-paste API examples; no product or runtime behavior changes.
Overview
Corrects the Recording and retention → Change them yourself example so org logging policy updates match how other control-plane routes are documented.
The
curlexample now useshttps://cloud.arcade.dev/api/v1/orgs/{org_id}/logging-configinstead ofapi.arcade.dev/v1/..., and$ARCADE_API_KEYinstead of the nonexistent$ARCADE_ACCOUNT_TOKEN. The surrounding text now points readers to the same org-scoped user auth model as the audit log API and states that a project API key gets401.Reviewed by Cursor Bugbot for commit 18b2a17. Bugbot is set up for automated code reviews on this repo. Configure here.