Page Comparison

This documentation provides a summary overview of the major improvements, updates, fixes, and changes made in previous releases of the Ed-Fi ODS / API v5.x suite of releases and provides links to additional documentation.

The changes include:

Detail about each change follows. 

Improvements & Enhancements - Version 5.2

Data Model Changes

Ed-Fi ODS / API v5.2 implements Ed-Fi Data Standard v3.3.0-a, which introduces changes to the core data model around the domains commonly captured in student information systems and assessment systems. These changes are intended to be non-breaking to most API clients. However, platform hosts should be aware that there are changes to the database as well as the build and deployment pipelines.

Data Standard v3.3.0-a can also be reviewed in the context of API specifications: 

• Ed-Fi Assessment Outcomes API for Suite 3 v1.0.1
• ED-FI RFC 24 - CORE STUDENT API
• ED-FI RFC 25 - SURVEY API

XSD Metadata Endpoint in ODS / API 

Ed-Fi ODS / API exposes OpenAPI Specification metadata that describes all the API resources as well as the inputs, HTTP verbs, and JSON schema of the exposed resources.

Ed-Fi ODS / API also exposes another metadata endpoint that indicates the dependency order for the API operations enforced through entity relationships in the ODS database or by authorization. 

In this release, Ed-Fi ODS / API adds another metadata endpoint that exposes the Bulk / XML standards (core entity XML definitions and interchange specifications) specified by the Data Standard the ODS / API implements.

These metadata endpoints are listed in the API root for easy access:

The Bulk Load Client Utility has been enhanced to read these metadata endpoints from the API root, and validate and load the source XML in the correct dependency order.

Snapshot Isolation for Change Query Processing

The goal of the changed record queries (or "change queries") feature is to surface information about the changes made to database tables to clients of Ed-Fi APIs. These changes include inserts, updates, and deletes. In previous versions of the ODS / API, due to transactional nature of live ODS, even careful change processing could not guarantee absolute downstream referential integrity unless API host operationally ensures that no other clients or processes are modifying ODS data while change processing is underway.

In this release, API hosts can implement a regularly scheduled activity that either creates a database snapshot (a SQL Server feature that creates a lightweight static "copy" of the database), or backs up and restores the ODS as a new database. The ODS / API then can expose the snapshot database for change processing. 

Package Management and Distribution 

In previous versions of ODS / API, the .NET binaries were released on MyGet. This release moves binaries to Azure Artifacts. This move supports more storage space and package workflow improvements. The Azure Artifacts best practices package promotion workflow is followed. Development packages are now published to @Local feed and release packages are promoted to the @Release feed. While technical artifacts of ODS / API follow semantic versioning as announced in May 2020, the new package promotion workflow results in a high patch number. This high patch number is due to daily builds during development rather than actual production patches. When there are production patches, they will be updated and highlighted in the Binary Releases page. 

Educator Preparation Data Model as a Plugin

Ed-Fi ODS / API v5.2 supports TPDM 2 supports EPDM v1.0 (previously TPDM) as optional dynamic extension plugin. Teacher preparation providers Educator Preparation Providers can use this extension to evaluate program improvements based on how their graduates perform in the classroom rather than on general or anecdotal evidence. See the Teacher Preparation Data Model documentation the documentation Educator Preparation Programs for more details on this extension. For instructions on how to deploy the extension see the article article Getting Started with EPDM/TPDM v1.0.

MetaEd IDE v2.5

Implementing extensions in ODS / API v5.2 requires implementers to update to MetaEd IDE v2.5.

Improvements & Enhancements - Version 5.1

Migration to .NET Core 

In previous Ed-Fi ODS / API releases, though the platform could be run in a variety of server environments including on-premises hardware or cloud-based platforms like Google Cloud, AWS, and Azure, the API servers had to be run on the Windows operating system. As announced in a recent blog post, this release migrates the source code to .NET core allowing full cross-platform support, supporting Windows and Linux operating systems. The upcoming ODS / API release will provide Docker deployments for a PostgreSQL-backed ODS on Linux servers.

Dynamic Extension Plugins

Extending the Data Model is one of the key features that draws implementers to the Ed-Fi ODS / API. Typically, this involves a development activity that modifies the ODS, data access code, API surface, Open API metadata, and more. Hence, extending the model requires CICD setup for build and deployment of extended API.

Many LEA implementations depend on the as-shipped Ed-Fi-published packages and do not have the resources to develop extensions. This release brings a dynamic extension feature which allows extension plugins to be created and then consumed at runtime by the ODS / API without source code changes. This opens up the door for LEA implementations to consume domain extensions (e.g., TPDM) and data exchange standards that are emerging as extensions (e.g., Finance, Assessment, and more in the future) without source code changes. The traditional extensions that require build and deployment are still supported. 

Teacher Preparation Data Model as a Plugin

Ed-Fi ODS / API v5.1.0 supports TPDM 1.0 as optional dynamic extension plugin. Teacher preparation providers can use this extension to base program improvements on how their graduates perform in the classroom rather than on general or anecdotal evidence. See Teacher Preparation Data Model for more details on this domain extension. For instructions on how to deploy the extension see the article Getting Started with TPDM v1.0. 

MetaEd IDE v2.4.0

Implementing extensions in OS / API v5.1.0 requires implementers to update to MetaEd IDE v2.4.0 or higher.

Additional Support for PostgreSQL-Backed ODS / API

The previous Ed-Fi ODS / API v3.x releases brought ODS / API PostgreSQL support to parity with Ed-Fi ODS / API cloud offering and added TPDM domain extension support. This release adds full Sandbox Admin Application support. 

Improvements & Enhancements - Version 5.0

Data Model Changes

ODS / API v5.0.0 implements Ed-Fi Data Standard v3.2.0-c. Noteworthy additions to the data model in v3.2.0-c include the Survey domain and Person model. There are no breaking API or JSON model changes accompanying this release. However, platform hosts should be aware that there are some breaking database changes. Refer to How To: View API and Database changes in the latest ODS / API Release to see the full set of API and database changes in this implementation. 

The data model changes introduced in Data Standard v3.2.0-c can also be reviewed in the context of API specification updates:

• SIS API. This release implements the latest Ed-Fi RFC 24 - Core Student API. The changes were designed to be non-breaking for most existing API client systems. 
• Survey API. This release implements Ed-Fi RFC 25 - Survey API, which is newly added in this release.

This release also implements Ed-Fi RFC 22 - Assessment Outcomes API, which is the same as previous Ed-Fi ODS / API v3.x releases. This means there are no new Assessment API changes accompanying this release.

MetaEd IDE v2.3.0

Implementing extensions in ODS / API v5.0.0 requires implementers to update to MetaEd IDE v2.3.0 or higher.

Teacher Preparation Data Model

The Ed-Fi ODS / API v5.0.0 implements TPDM v0.8 as an optional domain extension. Teacher preparation providers can use this extension to base program improvements on how their graduates perform in the classroom rather than on general or anecdotal evidence. Note that TPDM expands the fields required to implement credentials. With TPDM enabled, credential additionally requires a certification title and the use of the person model. More details on person model can be found at /wiki/spaces/TPDMDEV/pages/23038581. This extension is deployed by default in Ed-Fi ODS / API v5.0.0. 

Additional Support for PostgreSQL-Backed ODS / API

The previous ODS / API v3.4 release brought ODS / API PostgreSQL support to parity with Ed-Fi ODS / API cloud offering with the following scope of features:

• Core API
• Swagger UI
• Enrollment Composite
• Change Query

This release brings a few more significant additions:

• Sandboxing 
• TPDM domain Extension
• Full code generation support

Authorization Enhancements

ODS / API v5.0.0 brings several enhancements to API authorization. Significant changes include:

• API clients can be associated with different education organization types. In previous versions, it was required for client system developers to use different key/secret pairs to load data related to different ed-org types. This can now can be accomplished with one key/secret pair.
• API clients can be associated with multiple namespace prefixes. The namespace prefix assigned to a solution provider is used to authorize access to create, update, and delete descriptors, as well as to create, read, update, and delete Assessment-related data, Learning Standards, Learning Objectives, and Education Content. In previous versions, vendors had less flexibility in working with learning standard namespaces and managed descriptor namespaces due to lack of authorization support for multiple namespace prefixes. See Descriptor Guidance for information on how to access data by associating key/secret pairs with appropriate namespace prefixes.
• API Clients can use an OAuth token introspection endpoint to view security configuration information for the token. The endpoint aligns with the IETF RFC 7662 specification. 

Bulk Load Client Enhancements and Removal of Server-Side Bulk Load

With the ODS / API v3.3 release, the Alliance announced deprecation of server-side bulk loading of XML files. This release fully removes the server-side bulk load. Implementers who need to bulk load XML data can use the Bulk Load Client Utility which has been enhanced with modifications to use the Dependency endpoint instead of the less-reliable InterchangeOrderMetadata. The latest utility also contains performance improvements, detailed error logging, XML validation configurations, and more. 

Apache License

In April 2020, the Ed-Fi Alliance announced a move to the Apache License, Version 2.0 to lower the barrier to entry for EdTech vendors, universities, school districts, and states, and to encourage continued community contribution to the technology. This release delivers on that promise and moves the source code to https://github.com/Ed-Fi-Alliance-OSS/ under the Apache license. The Ed-Fi License is no longer required to access ODS / API source code. 

Semantic Versioning 

In May 2020, Ed-Fi announced adapting semantic versioning for Data Standard and ODS / API. This release is identified as ODS / API for Suite 3 v5.0.0. Releases packages for this release reflect this change by adding the Ed-Fi Suite number to the package name, along with the semantic version number for the release.