GalleonQL Manual
Changelog

GalleonQL User Manual

This is the end-user manual for GalleonQL (a GraphQL-focused client). It covers terminology and how to use the app, and does not include developer-facing content (internal specifications or implementation steps).

(Topics are written up progressively. The table of contents follows.)

Table of Contents

  1. What GalleonQL Is (Overview) / Installation and Launch — An overview of GalleonQL and how to install and launch it on each OS (macOS / Windows / Linux), including how to open the unsigned Windows and Linux binaries.
  2. Key Terms — Environment (a switchable connection profile / orthogonal model) / Collection / Query / add Query · add Child / leaf and branch / environment variables {{...}} and GraphQL variables $id / header cascade / HTTP timeout cascade / Schema
  3. Importing a Schema — Importing via HTTP introspection, and importing from local files
  4. Browsing the Schema Documentation — The type catalog of an imported schema (browsing and searching types and fields)
  5. Query Builder — Building a query step by step with add Query / add Child, and switching granularity
  6. Registering and Switching Environments — Registering, editing, and switching environments (connection profiles), and configuring environment variables, authentication, headers, and HTTP timeouts
  7. Reordering and Moving — Changing the order of query fields, collections, favorites, environments, and projects (drag and drop / Option + ↑↓ / the ⋯ menu)
  8. Renaming and Creating Folders — Renaming folders, saved queries, environments, and projects (double-click / F2 / the ⋯ menu), and creating collection folders
  9. Sending Queries and Reading Responses — Choosing the HTTP method, previewing the final headers, and the classification of results and errors (Network / Authentication / Client / Server / Partial errors)
  10. Request hooks (extract and assert) — After send: extract response values into environment variables, or declaratively assert status/body (Pro)
  11. Exporting / Importing Projects — Exporting and importing on a per-project basis, and third-party collection import (Postman v2.1 GraphQL, Pro)
  12. Plans (Free / Pro) and licenses — Free vs Pro, Pro-only features (hooks including assertions, Subscription, schema diff, third-party import), license apply/remove
  13. Crash Reporting — Enabling crash / error reporting and using the pre-send confirmation
  14. Usage Analytics — Enabling / disabling anonymous usage analytics (a separate consent from crash reporting)
  15. Changelog — See the GitHub release notes for the changes in each version (this manual carries no body text for it, only an external link)