Skip to content
Cratis Cratis Cratis

Introspection Queries Endpoint

The queries introspection endpoint returns metadata for every mapped query.

Endpoint

Section titled “Endpoint”

GET /.cratis/queries

What it returns

Section titled “What it returns”

The endpoint returns a JSON array where each item describes one query endpoint.

Each item includes:

  • name: Query name.
  • namespace: Namespace derived from the mapped location.
  • route: The resolved query route, built with the same route helper used by the runtime query mapper. It honors the configured route prefix and SegmentsToSkipForRoute value.
  • type: Fully qualified query type name.
  • documentationSummary: Summary text from type metadata when available.
  • argumentsSchema: JSON Schema for query arguments, including argument names, types, and required fields.

Typical uses

Section titled “Typical uses”
  • Build runtime query explorers for developers.
  • Validate query route generation across features.
  • Feed endpoint metadata into local API diagnostics tools.