Repository navigation
EN Team Roles
Français · Reference · Published, reviewed by a person · Applies from: 4.4.0
On a team Studio every member has one role: owner, dev or reviewer. This page lists every route of the Studio
Server and the role it needs, read from the code: the gate
(auth/gate.ts), the role of each API route (roleFor in
http.ts), the owner's routes
(auth/routes.ts) and the API's table
(ops/routes.ts).
Audience, context, and the statuses of what this page rests on
Audience: author, admin · Context: hosted Studio
The Studio Server (hosted team Studio) · contract: experimental · verified by CI (support matrix of 4.4.0, 2026-10-23): Postgres, S3 and Keycloak in CI; Chromium and Firefox (job studio-hosted); WebKit on macOS, by hand only · automated checks: jobs
studio-hosted,studio-install-smoke; CI planstudioHosted; 3 test files · people's passes:studio-hostednot run (#149),studio-collabnot run (#150),studio-previewnot run (#166),studio-assets-hostednot run (#167),studio-mcp-remotenot run (#196),studio-oidc-genericnot run (#197) · known limits:roles-fixed
- The roles are ranked:
reviewer<dev<owner. A route that needsdevis open to owners too. -
The rule: a
GET(and aPOSTthat only reads, such as a check) needs a reviewer; any other write needs a dev; the members, the invitations, the audit and a few whole-game actions need an owner. The exceptions are listed in each table. - Below the role a route needs, the answer is 403
this needs the role <role>. A logged-in person who is not a member gets 403not a member of this project. Without a session or a token: 401. - The role is checked on every request, with the session cookie (the browser) or a Bearer access token (the CLI, scripts, the MCP). A role changed or a member removed takes effect at their next request.
- The routes below are under the Studio's public URL. The game's origin (
playUrl) has its own rules, at the end.
Everything a dev may do, plus: the members, their roles and sessions, invitations, the audit log; taking a span over; the exclusive lease by hand; Git push and import; the engine's upgrade; a fresh rebuild of a published build; bringing the notes in as comments; cancelling anyone's job. The last owner can be neither demoted nor removed.
Writes the game, span by span: rooms, texts, values, the storyboard, the map's groupings, notes, voices, uploads and cuts, Prepare, undo and redo of their own operations, publishing a build, asking for a bisection, taking and releasing spans. Resolves any comment thread. Cancels the jobs they started.
Reads and plays: every read of the game and of the Studio, the checks (validator, solver, lint…), the previews and builds, the live stream. Writes no game file. Comments, edits their own comments, and resolves their own threads. Holds no lease.
| Route | reviewer | dev | owner |
|---|---|---|---|
GET /api/game, /api/room/<id>, /api/ir, /api/graph, /api/history
|
yes | yes | yes |
GET /api/storyboard, /api/groupings, /api/map, /api/notes
|
yes | yes | yes |
GET /api/voices, /api/voices/<lang>, /api/voices/<lang>/csv, /api/hero-matrix
|
yes | yes | yes |
GET /api/diff/<a>..<b> |
yes | yes | yes |
GET /api/diff/<a>..<b>/captures (501 on a hosted Studio) |
yes | yes | yes |
PUT /api/room/<id>/layout, /text, /value; POST /api/room/<id>/add
|
no | yes | yes |
PUT /api/room/@game/value (the game's objectives) |
no | yes | yes |
PUT /api/storyboard, POST /api/storyboard/markdown
|
no | yes | yes |
PUT /api/groupings |
no | yes | yes |
POST /api/notes, PUT /api/notes/<id>, DELETE /api/notes/<id>
|
no | yes | yes |
PUT /api/voices/<lang>/<id> |
no | yes | yes |
POST /api/undo, POST /api/redo (your own operations) |
no | yes | yes |
| Route | reviewer | dev | owner |
|---|---|---|---|
POST /api/validate, /report, /puzzle, /coverage, /playtests, /lint, /solve
|
yes | yes | yes |
POST /api/screenshot (501 on a hosted Studio) |
yes | yes | yes |
GET /api/revision, GET /api/ops?after=<rev>
|
yes | yes | yes |
POST /api/health/bisect {good, bad}
|
no | yes | yes |
These POSTs only read: they take their options in a body, need no lease, and are never refused for a span.
| Route | reviewer | dev | owner |
|---|---|---|---|
GET /api/events (the live stream) |
yes | yes | yes |
POST /api/presence (the heartbeat; it also renews a dev's or owner's leases) |
yes | yes | yes |
GET /api/leases |
yes | yes | yes |
POST /api/leases {spans}, POST /api/leases/release {spans?}
|
no | yes | yes |
POST /api/leases/takeover {span}
|
no | no | yes |
POST /api/exclusive, POST /api/exclusive/release
|
no | no | yes |
POST /api/play-ticket (a browser session only, never a Bearer token) |
yes | yes | yes |
| Route | reviewer | dev | owner |
|---|---|---|---|
GET /api/comments, POST /api/comments
|
yes | yes | yes |
PUT /api/comments/<id> with text
|
own comments | own comments | own comments |
PUT /api/comments/<id> with resolved
|
own threads | any | any |
POST /api/comments/import-notes |
no | no | yes |
Only its author changes a comment's text, whatever their role (403 otherwise). There is no route to delete a comment.
| Route | reviewer | dev | owner |
|---|---|---|---|
GET /api/assets, /api/assets/prompts, /api/assets/file/<path>, /api/assets/prepared
|
yes | yes | yes |
POST /api/assets/sound, /decor (uploads) |
no | yes | yes |
POST /api/assets/sheet, /cell, /prepare (jobs, under your exclusive lease) |
no | yes | yes |
GET /api/jobs/<id> |
yes | yes | yes |
POST /api/jobs/<id>/cancel |
no | jobs they started | any job |
GET /api/builds, GET /api/builds/<n>
|
yes | yes | yes |
POST /api/builds (publish the head) |
no | yes | yes |
POST /api/builds/<n>/rebuild (rebuild fresh) |
no | no | yes |
The game's images and sounds on the Studio's origin (/assets/img/…, /assets/audio/…, /assets/video/…) |
yes | yes | yes |
| Route | reviewer | dev | owner |
|---|---|---|---|
GET /api/members (members and pending invitations) |
no | no | yes |
POST /api/invitations {email, role}
|
no | no | yes |
PUT /api/members/<id> {role}
|
no | no | yes |
DELETE /api/members/<id> |
no | no | yes |
DELETE /api/members/<id>/sessions |
no | no | yes |
GET /api/audit |
no | no | yes |
GET /api/git |
yes | yes | yes |
POST /api/git/push, POST /api/git/import {ref?}
|
no | no | yes |
POST /api/engine/migrate |
no | no | yes |
See Managing members, The game in Git and Upgrading the engine of a hosted game.
POST /mcp takes a Bearer access token only (never the session cookie), from a member: a reviewer at least. Each tool
is then a request to the same /api with the caller's token, so a tool needs the role of its route: a reviewer's
agent reads and checks, a dev's agent writes. See Remote MCP.
| Route | Who |
|---|---|
GET /livez, /startz, /readyz
|
anyone (no data) |
GET /metrics |
the bearer of STUDIO_METRICS_TOKEN only, never a session (Health and metrics routes) |
GET /.well-known/oauth-protected-resource, /.well-known/oauth-protected-resource/mcp
|
anyone |
The Studio's page and its static files (/, /assets/… other than images, sounds and video, /icons/…, /fonts/…) |
anyone (they hold no data) |
GET /auth/login, GET /auth/callback, POST /auth/backchannel, GET /auth/cli
|
anyone |
GET /auth/me, POST /auth/logout
|
anyone logged in, member or not (/auth/me answers role: null for a non-member) |
Every /auth/… route takes 30 requests a minute per address at most; past that it answers 429 with Retry-After: 60.
On playUrl no Studio API and no /auth route answer. Every path needs a game session, made from a ticket that a
member's browser session asked for (POST /api/play-ticket): any role. The game session lasts 15 minutes, sliding,
and is checked at every request against the member's Studio session and membership. With publicBuilds: true in the
configuration, /play/… and /icons/… (the published builds) open without a session, to anyone.
Even with the right role, a write can be refused:
- 423: the span is held by someone else, or the whole game is (423).
- 409: the file changed since you read it (409), or the last owner would be demoted or removed.
-
403
forbidden: a browser write without the exactOrigin, the headerX-Studio-Request: 1and a JSON body. -
503 with
Retry-After: the instance does not serve writes yet (a redeploy), or the identity provider has not confirmed your session for 15 minutes (suspended). - 429: too many refused authentications from one address in a minute (30), or a busy job queue.
Guarantee ·
roles-read-review-write-dev· referenced · executed onb061c4ae6fbe· scope reviewed Every route of the Studio API's table needs a reviewer when it only reads (aGET, or one of the read-onlyPOSTs) and a dev otherwise; the test walks the whole table.
Limit ·
roles-fixedThe three roles are fixed: there is no custom role, no per-room right, and no read-only dev. A provider's groups give no right.
- Managing members, Invitations.
- Concepts: spans, leases, the exclusive lease.
- ADR 0027: the four HTTP policies.
Generated publication · publication générée — current documentation · documentation courante: quest'n'click 4.5.3 r1, documentation revision · révision de la documentation b061c4ae6fbeb0be47a11ba8a442ba7e23ecb0a1.
Latest documentation · dernière documentation: https://quest-n-click.cleverapps.io/docs · https://quest-n-click.cleverapps.io/fr/docs; earlier versions · versions précédentes: each release's quest-n-click-docs-<version>.tar.gz · l'archive quest-n-click-docs-<version>.tar.gz de chaque release, https://github.com/Quest-n-Click/quest-n-click/releases
An edit made in this wiki is overwritten at the next publication · une modification faite dans ce wiki est écrasée à la publication suivante.
Edit the source · Modifier la source · Report an error · Signaler une erreur
Index (6)
Start (6)
Play (9)
Install (18)
- Requirements
- Install from the release archive
- Install from npm
- Install from the repository to work on the engine
- doctor: checking your machine
- Image toolchain
- Audio toolchain: ffmpeg, fluidsynth, Furnace, uv
- Upgrade
- Upgrade notes: 4.5
- Upgrade notes: 4.4
- Upgrade notes: 4.3
- Upgrade notes: 4.2
- Upgrade notes: 4.1
- Upgrade notes: v3
- Upgrade notes: v2 to v3
- Coming from web-scumm
- Package reference
- Install troubleshooting
Create a game (55)
- Your first game
- Layout of a created project and of the engine repository
- The working loop
- Content principles and the identity contract
- Rooms
- Geometry: placement, walk zones, masks, layers, camera
- Something is visible but unreachable
- Reactions
- Game commands
- Conditions
- Flags, variables and events: which to use
- Custom code
- Characters
- Items and inventory
- World map
- Dialogues
- Scripts and events
- Moving characters: patrols and walks
- Exits
- Chapters and objectives
- State and saves: persistent or temporary, renaming an id, migrations
- Staging: wide rooms and animations
- The stage: lights, particles, floors
- Skin and fonts
- Title and credits
- Heroes: several characters and hero choice
- Built-in minigames
- A custom minigame
- Translations
- Music in stems
- Sound effects
- Voices: per language and per hero
- Images: prompts, cutting sheets, transparency, scale
- Asset provenance
- The storyboard, source of truth
- Puzzle design
- Classic mechanics
- Review pages
- DSL reference
- Checking your game
- What the solver proves
- Solver options
- Playtests
- Remix
- Speedrun for authors
- The sealed ending
- Production template
- Example games
- Working with an AI
- Build and release a game
- Publish on GitHub Pages
- The static game on Clever Cloud
- Other static hosts
- Sub-path, cache and service worker, incomplete deploys, going back
- Testing on a phone over the LAN
Local Studio (24)
- The local Studio: overview and launch
- Edit a room
- Placement and stage
- Preview, apply, undo
- Storyboard
- Assets and cutting
- Check: validator, solver, critical path, heat, health, coverage
- Before and after captures
- Semantic diff
- Play and replay a session
- Rule explainer
- Language and objectives
- Voices and the heroes × languages matrix
- Map
- Notes
- Remix in the Studio
- Music
- The Assistant: bring your own key
- Demo mode and studio-apply
- Local and LAN security
- Studio API
- Local MCP: setting up each client
- MCP tools
- Studio troubleshooting
Team Studio (21)
- What runs where
- Concepts: revision, transaction, span, lease, preview, build
- Starting as an invited dev
- Working together day to day
- Roles and actions: the full matrix
- Invitations
- Managing members
- Write refused on the hosted Studio: stale base revision (409)
- Write refused on the hosted Studio: span locked (423)
- Recovering after a lost lease, a disconnection or a stale preview
- Comments
- Map and semantic diff
- Publishing builds
- Remote MCP
- The game in Git
- Upgrading the engine of a hosted game
- Hosted assets
- The server's command line
- Health and metrics routes
- Trying it locally with compose.yml
- Known limits
Clever Cloud (23)
- Clever Cloud: overview, cost and prerequisites
- Apps and add-ons
- Domains and TLS
- Keycloak
- Generic OIDC and GitLab
- Configuration
- First deployment
- Backups
- RPO and RTO
- Restore the Studio on a fresh installation
- Redeploys
- Upgrading the server and checking state after a migration
- Limits of going back
- Monitoring
- Security
- Rotating keys
- Recovering admin access
- Changing domain or OIDC provider
- Worker, PostgreSQL or Cellar down
- Exporting the game and leaving the installation
- Retention
- Clever Cloud troubleshooting
- Costs and teardown
Reality Bridge and connectors (16)
- The Reality Bridge: what it is
- Quick start
- Guarantees
- Install and run the Bridge
- Backup and restore
- Several tenants
- Signals and the manifest
- The Bridge's command line
- Connectors overview
- Email connector
- Telnet connector
- SSH connector
- Open Badges connector
- The connector SDK
- Security: Biscuit and signatures
- Bridge and connector troubleshooting
Contribute (25)
- Welcome
- Developer setup
- The dev loop
- Before a pull request
- Conventions
- Writing documentation
- Architecture
- Code tour
- Import boundaries
- Which tests run when
- Mutation testing
- The coverage ratchet
- The quality baseline
- CI explained
- Field passes
- Benchmarks
- Releasing
- npm packages
- Decisions and ADRs
- Governance
- Bot pull requests
- Contributing with AI agents
- Security policy
- Code of conduct
- Licences and credits