Skip to content
v2.1.0

Schema, autocomplete and docs

Loading a schema, using autocomplete and lint in the editor, and browsing the Docs explorer. Narrated, with sound. The dark and light versions follow the site's theme.

Wireglass introspects over HTTP, with the tab’s headers and cookie setting, only when you ask:

  • when you Run a query in the tab, if no schema has been loaded for this request yet, or
  • when you click Refresh schema.

Typing an endpoint, switching tabs, reopening the client or a change synced from another window only shows a cached schema if there is one. Nothing is sent to an endpoint until you Run or Refresh.

The schema status sits in the request bar, after the endpoint: the state (for example Schema loaded · 42 types), a Refresh schema icon and a Docs button. Point at the status to read all of it. When the client is narrow, the status becomes a coloured dot and Docs a book icon, so the bar stays on one row.

  • Autocomplete while you type. Press Enter or Tab to accept.
  • Lint underlines for fields and arguments the schema doesn’t know.
  • Docs explorer. Click Docs to browse root types, every type, and each field’s arguments, descriptions and deprecations. Ctrl/⌘-click a field or type in the editor to open it in the docs.

The Variables editor suggests what your operation needs:

  • the variables it declares, required ones first, each with its type (ID!, [String!]…); ones already set are left out;
  • with a schema loaded, the fields of an input type when you are inside one, and the values of an enum or Boolean where a value goes.

Picking a name fills in its quotes and colon, and for an enum or Boolean it goes straight on to the values. Without a schema it still suggests the variable names, read from the query. With several operations in the query, it uses the one selected beside Query.

Headers suggests common header names (Authorization, Content-Type, …). In both editors, typing {{ suggests the variables of the active environment, the globals and the built-in values.

Suggestions open once you start typing a name or a quote; Ctrl + Space opens them anywhere.

Pressing Enter at the end of a finished entry in Variables or Headers adds the comma JSON needs before the next one. In scripts, Enter at the end of a finished statement adds its semicolon. A line that opens a bracket, an if (…) or loop header, and a statement that carries on onto the next line are left alone.

Runs forgive the slips this guards against, too: a comma missing between entries on separate lines, or a trailing comma before } or ], is fixed when the request is sent instead of failing as invalid JSON. Text inside strings is never changed. Turn the Enter behaviour off with Settings → Code → Add missing commas and semicolons.

Schemas are cached per endpoint in chrome.storage.local: up to 10 endpoints and 6 MB in total. A single schema larger than 3 MB is used but not cached.

The schema status says so, and queries still run without a schema. Add the auth headers in Headers, then Run or click Refresh schema again. Wireglass never retries on its own.

In Settings → Code: Autocomplete while typing, Schema lint underlines and Add missing commas and semicolons. See Settings.