Skip to content

Introspection Queries Endpoint

The queries introspection endpoint returns metadata for discovered query performers, not the final runtime route table.

GET /.cratis/queries

Normal Arc activation maps this endpoint anonymously in Development and requires authentication elsewhere by default. A host that cannot authenticate leaves it unmapped and logs a warning. Returned metadata is not filtered by the caller’s query permissions. See production access controls.

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

Each item includes:

  • name: Query name.
  • namespace: Namespace derived from the performer’s location after skipping the default namespace segments.
  • route: Explicit [Path] if present; otherwise the convention-derived query route using the default route options, not Cratis:Arc:GeneratedApis (ArcOptions.GeneratedApis).
  • fullyQualifiedName: The performer’s fully qualified query name.
  • 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.

Introspection applies a performer’s custom [Path], but does not mirror all final route deduplication/replacement decisions. Treat it as discovered-operation metadata, not an authoritative inventory of callable URLs. Queries marked [ExcludeFromDiscovery] on the read model or method are omitted without disabling their routes.

  • Build query metadata explorers for developers.
  • Inspect conventional query route generation across features.
  • Feed endpoint metadata into local API diagnostics tools.