Platform Dev Guide - Features

Platform Dev Guide - 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

Is Enabled by Default

Description

Feature

Is Enabled by Default

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. 

identityManagement

false

Enables the Identity API endpoints.

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 - Student Transportation Example or by deploying dynamic extension plugins see How To: Deploy an Extension Plugin for details.

uniqueIdValidation

false

Enables Unique ID Validation. This requires custom implementation of IUniqueIdToIdValueMapper and its registration within the WebApi. 

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.

Contents