A newer version of the Ed-Fi ODS / API is now available. See the Ed-Fi Technology Version Index for a link to the latest version.

What's New - Release Notes

Owned by Ian Christopher (Deactivated)
Last updated: Aug 08, 2022 by Vinaya Mayya

This section provides a comprehensive list of the improvements, updates, fixes, and changes in the Ed-Fi ODS / API for Suite 3 v5.1.0 release, with links to the relevant issue in the Ed-Fi Tracker.

Patch Release - v5.1.1 

  • [ODS-5528] - Swagger UI: Disable configUrl and url parameters

Ed-Fi ODS / API v5.1.0 - Release Notes

Important Epics

  • [ODS-3504] - Convert ODS/API to .NET Core
  • [ODS-3667] - Dynamic/pluggable TPDM extension
  • [ODS-4025] - Sample Extensions as dynamic extension plugin

General Improvements & Enhancements

  • [ODS-3646] - Publish API Bulk Load Tool for Download
  • [ODS-3670] - Remove composites API "hierarchical" feature
  • [ODS-3873] - Use EdFi.Common package in ODS solution
  • [ODS-3936] - Add support for Descriptor sub-properties in Composites
  • [ODS-4126] - Expose Common Urls Through API
  • [ODS-4332] - Connection provider implementation for instance/school year specific ODS
  • [ODS-4358] - Remove EdFi_Ods_Empty_Template database
  • [ODS-4401] - Bring in Swashbuckle as a Replacement for swagger-ui
  • [ODS-4402] - Add Year Specific Customizations to Swashbuckle
  • [ODS-4537] - Support PostgreSQL "money" data type in API GetByExample requests
  • [ODS-4629] - Setup Change Query feature on by default

Bug Fixes

  • [ODS-3830] - EdFi.Db.Deploy does not display version information
  • [ODS-4022] - availableChangeQueries OpenApi Spec definition is incorrect
  • [ODS-4023] - Enrollment Composite OpenAPI spec shows change queries artifacts
  • [ODS-4263] - PostgreSQL GetByExample fails when attempting to convert money datatype to numeric
  • [ODS-4343] - Incorrect Default Data Standard Directory in Client Bulk Load Console
  • [ODS-4394] - Swagger metadata endpoint for change query doesn't work when IdentityManagement feature is turned off
  • [ODS-4535] - Path-resolver retaining previously resolved modules - EdFi.Suite3.Installer.WebApi.1.0.0
  • [ODS-4592] - Duplicates from Security Views
  • [ODS-4638] - Typo in TPDM source file directory

Ed-Fi ODS / API v5.1.0 - Known Issues

The table below identifies key areas of functionality that are known to have issues in this release.

Area

Issue

Tracker Ticket*

Endpoint /ed-fi/sections 

The locationSchoolReference field is unusable.

  • If both locationReference and locationSchoolReference are submitted, the locationReference school will be saved.
  • If only locationSchoolReference is submitted (without a locationReference), then it will not be saved.
  • If only locationSchool is submitted, the locationSchoolReference will appear populated on a GET.

ODS-3082 - Getting issue details... STATUS

You can also view release information in Ed-Fi Tracker here.