Features
The Ed-Fi ODS / API comes with a set of configurable features that can be enabled or disabled using configuration settings in deployed API. This section contains additional reference documentation for these configurable features.
| Feature | Default State | Description |
|---|---|---|
| changeQueries | true | The Changed Record Queries feature can be enabled or disabled via configuration. Database configuration remains a separate step, see Using the Changed Record Queries. |
| openApiMetadata | true | The metadata API endpoint used by Swagger UI can be enabled or disabled via configuration. It is recommend for Production deployments to disable this. |
| composites | true | The Composites API endpoints can be enabled or disabled via configuration. This includes the default Enrollments composite and any custom composites that have been added to the platform. |
| profiles | true | The Profiles feature can be enabled or disabled via configuration. |
| extensions | true | Enables the API endpoints created for all Extensions. Installations can be extended by modifying source code see How To: Extend the Ed-Fi ODS / API - Alternative Education Program Example or by deploying dynamic extension plugins see How To: Deploy an Extension Plugin for details. |
| tokenInfo | true | Enables oauth token_info introspective endpoint which provides the additional security configuration information for the token. See Token Info section for mode details. |
| 🆕 serializedData | true | Activates optimized behavior in the API to serialize the resource data into a binary representation that is stored on the "root" record of the resource's underlying table in the ODS. This serialized representation is then used as the primary source for servicing future API requests, significantly reducing the SQL that executed by the API to retrieve data while processing API requests. |
| 🆕 resourceLinks | true | Controls the inclusion of link objects in references in responses from the Data Management resource endpoints. Disabling this feature is a server-side optimization reducing database load, but comes with the risk of breaking API client integrations that utilize them. |
| identityManagement | false | Enables the Identity API endpoints. |
| uniqueIdValidation | false | Enables Unique ID Validation. This requires custom implementation of IUniqueIdToIdValueMapper and its registration within the WebApi. |