Features
This section contains reference documentation for the built-in features of the Ed-Fi API.
| Feature | Description | How it's enabled |
|---|---|---|
| Changed record queries | The Changed Record Queries feature tracks inserts, updates, and deletes on resources. See also Using the Changed Record Queries. | Always available. |
| Change query snapshots | Serves change query reads from a point-in-time copy of the data store, so a client sees a stable view while it syncs. See Changed Record Queries with Snapshot Isolation. | Register a Snapshot data store derivative in the Configuration Service. Clients send the Use-Snapshot: true header. |
| Read replicas | Sends read requests to a read-only replica of the data store's database. See Read Replicas. | Register a ReadReplica data store derivative in the Configuration Service. |
| OpenAPI metadata | The OpenAPI metadata endpoints used by the Swagger UI. | Always available. Exclude specific domains with the AppSettings:DomainsExcludedFromOpenApi setting. |
| Profiles | The Profiles feature constrains API client access to specific resource properties for read and/or write operations. | Always available. Create profiles and assign them to applications in the Configuration Service. |
| Extensions | API endpoints for Extensions loaded from the schema directory. | Stage the extension schema and a schema workspace manifest in the AppSettings:ApiSchema:Path directory, set AppSettings:ApiSchema:UseCustomPath to true, and provision the database. |
| Token info | The OAuth token_info introspection endpoint, which provides security configuration information for a token. See Token Info for details. | Always available. |
| Resource links | Adds a link object to each resolved reference in a response. | On by default. Set DataManagement:ResourceLinks:Enabled to false to turn it off. |
| DocumentCache | Stores ready-to-serve copies of resources to speed up reads. See DocumentCache. | List the data stores to cache in DataManagement:DocumentCache:Targets. Set DataManagement:DocumentCache:ReadAcceleration:Enabled to true to serve reads from the cache. |
| Event streaming | Publishes data changes to Kafka through change data capture (CDC). See Event Streaming with Kafka. | Configure a DocumentCache target for the data store, then enable change data capture with the api-schema-tools cdc commands. |
| Identity management | The /identity/v2/identities API, backed by an identity plugin. See Plugins. | Set DataManagement:IdentityManagement:Enabled to true and install an identity plugin. |
| Plugins | Code extensions, such as Unique ID validation against an external identity system, loaded at startup. See Plugins. | List each plugin's directory name in Plugins:Allowed. |