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.6",
  "capabilities": {
    "query": {
      "aggregates": {},
      "variables": {},
      "nested_fields": {
        "filter_by": {},
        "order_by": {},
        "aggregates": {}
      },
      "exists": {
        "nested_collections": {}
      }
    },
    "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.exists.nested_collectionsWhether the data connector supports exists expressions against nested collections
capabilities.query.variablesWhether the data connector supports queries with variables
capabilities.query.explainWhether the data connector is capable of describing query plans
capabilities.query.nested_fields.filter_byWhether the data connector is capable of filtering by nested fields
capabilities.query.nested_fields.order_byWhether the data connector is capable of ordering by nested fields
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