Reference for <systemKey>-datasource-*.json — business metadata, dimensions, foreign keys, capabilities, CIP execution, sync, and exposure.
Source of truth
- Schema file:
external-datasource.schema.json(shipped with the Builder CLI schema bundle) - Schema key:
external-datasource-schema - Version: 2.7.2 (verify in schema
metadata.version)
Validate:
aifabrix validate <datasourceKey>
aifabrix datasource validate <datasourceKey>
Top-level fields (summary)
| Field | Purpose |
|---|---|
key / systemKey |
Datasource and parent system identifiers |
entityType / resourceType |
Business entity classification |
fieldMappings |
Attributes, dimensions, search/display mappings |
foreignKeys |
Cross-system relationships |
capabilities |
Supported operations (list, get, custom) |
execution |
CIP pipeline configuration |
sync |
Bulk/incremental load behavior |
exposed |
REST/MCP publication flags |
externalSpec |
Authoritative vendor/API spec reference for this datasource |
configuration |
Optional datasource-level runtime variable overrides (name/value) |
Important rules
- Root
externalSpecis the datasource-grade contract source; system JSON OpenAPI/MCP are hints only. - Dimensions and
foreignKeysdrive ABAC and Enterprise Knowledge relationships. - Published MCP/REST tools deduplicate to enterprise capability keys at compile time.