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.
|
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.