Skip to content

docs(openapi): state the scopes the SPARQL route requires - #140

Merged
EthanThatOneKid merged 1 commit into
mainfrom
sparql-scope-docs
Oct 18, 2026
Merged

EthanThatOneKid merged 1 commit into
mainfrom
sparql-scope-docs

Conversation

@EthanThatOneKid

Copy link
Copy Markdown
Contributor

What

The POST /worlds/{worldId}/sparql description now says which permission scopes the route needs. SELECT and ASK need data:read. SPARQL UPDATE needs data:write, and a key without it gets 403 before the update runs. An unparseable query returns 400 INVALID_ARGUMENT. #139 made the route behave this way; until now the reference didn't say so.

I regenerated openapi/openapi.json with pnpm run sync:openapi rather than hand-editing it. The only change is that one description string.

Downstream

  • docs.wazoo.dev: the API reference reads the live production spec (https://data.wazoo.dev/openapi.json), so the new text appears there only after the next manually triggered deploy-prod.
  • worlds-client-ts: it picks up the snapshot when it publishes. Only a doc comment changes, with no type or contract change, so merge order doesn't matter.

Checks

Typecheck is clean. All 226 tests pass, including the openapi-doc snapshot test. Prettier is clean.

Behavior was already confirmed live on QA: see the #138 comment.

🤖 Generated with Claude Code

The route description now says SELECT and ASK need data:read and SPARQL UPDATE needs data:write (enforced since #139), and that an unparseable query returns 400. Snapshot regenerated with sync:openapi.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@EthanThatOneKid
EthanThatOneKid merged commit dd6b9a3 into main Oct 18, 2026
7 checks passed
@EthanThatOneKid
EthanThatOneKid deleted the sparql-scope-docs branch October 18, 2026 23:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant