Capabilities

The capabilities endpoint provides metadata about the features which the data connector (and data source) support.

Request

GET /capabilities

Response

See CapabilitiesResponse

Example

{
  "version": "0.1.2",
  "capabilities": {
    "query": {
      "aggregates": {},
      "variables": {}
    },
    "mutation": {},
    "relationships": {
      "relation_comparisons": {},
      "order_by_aggregate": {}
    }
  }
}

Response Fields

NameDescription
versionA semantic version number of this specification which the data connector claims to implement
capabilities.query.aggregatesWhether the data connector supports aggregate queries
capabilities.query.variablesWhether the data connector supports queries with variables
capabilities.query.explainWhether the data connector is capable of describing query plans
capabilities.mutation.transactionalWhether the data connector is capable of executing multiple mutations in a transaction
capabilities.mutation.explainWhether the data connector is capable of describing mutation plans
capabilities.relationshipsWhether the data connector supports relationships
capabilities.relationships.order_by_aggregateWhether order by clauses can include aggregates
capabilities.relationships.relation_comparisonsWhether comparisons can include columns reachable via relationships

See also