API
  • API Index
  • Batch API
  • Content Negotiation
  • Dynamic Paths
  • Query Explanation
  • Hierarchy API
  • List API
  • Quick Reference
  • Time Series API
  • Views
      • Configuration
  • Overview
  • Application Configuration
  • Documentation Configuration
  • Spec Configuration
      • Features
  • API Testing
  • Asynchronous Processing
  • Cassandra Time-Series Engine
  • Cassandra Integration
  • Default Controller Customisation
  • Documentation
  • Query Explanation
  • Geospatial Filtering
  • Model Documentation
  • PostgreSQL Integration
  • Excel Spreadsheet Format
      • Tutorials
  • Step-by-Step Guide
  • Archetype Setup
  • Logging
  • Prometheus
  • Sentry Logging
      • UI Customisation
  • UI Customisation
  • SASS Build Chain
  • Shared Layout
  • API Documentation
  • Model Documentation
  • Results
    • sapi-nt v current

    Query Explanation

    Sapi-nt supports query explanation for the purposes of debugging endpoints and informing users. See this document for full details of how to use this feature.

    To enable query explanation, set the sapi-nt.web.controller.explain.enabled configuration property to “true”. When you do, explanation is enabled for all endpoints by default. To disable it for each endpoint, set the enabled property on the nested explain property of the spec to false.

    Property Description Default
    sapi-nt.web.controller.explain.enabled Determines whether to respond to query explanation requests. false
    sapi-nt.web.controller.explain.path The URL path segment to append to an existing endpoint path to make a query explanation request. /explain

    You do not need to configure the explain controller path as the default value is sufficient.