A newer version of the Ed-Fi ODS / API is 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: Oct 28, 2020 by Vinaya Mayya
3 min read

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

Patch Release - v5.0.1 

(Released 10/02/2020)

  • [ODS-4562] - CallContext loses values for a previous context when the same value is set for another context

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

Important Epics

  • [ODS-3786] - Bulk Load Client Utility Improvements
  • [ODS-3807] - Domain extension support in PostgreSQL
  • [ODS-3809] - Deprecation and removal of server side bulk load
  • [ODS-3915] - Bring in TPDM v0.8 as an optional extension
  • [ODS-4056] - Remove Code-Gen local Database Dependency
  • [ODS-4132] - Semantic Versioning Adoption
  • [ODS-4139] - Implement Survey Model
  • [ODS-4165] - OSS: Apache Licensing Conversion
  • [ODS-4173] - Align ODS /API to v3.2c Data Standard
  • [ODS-4202] - Authorization of multiple ed-org types

General Improvements & Enhancements

  • [ODS-1520] - EdFi.Ods.SandboxAdmin.Web should add global exception logging for API calls as well
  • [ODS-1856] - Increase API response page size limit
  • [ODS-1958] - Show LEA's and Schools with Permission
  • [ODS-2980] - vendor access to multiple namespace prefixes
  • [ODS-3876] - .NET Core upgrade to 3.1
  • [ODS-3912] - Sandbox Admin App support for PostgreSQL
  • [ODS-4033] - Add support for OAuth2 "scope" parameter to scope the resulting access token to a specific EdOrg
  • [ODS-4046] - Recreating student, staff or parent after deletion returns 400 Bad Request
  • [ODS-4136] - Remove sample extensions from SDK
  • [ODS-4151] - Provide a Npgsql configuration file with EdFi.RestApi.Databases.EFA package
  • [ODS-4172] - Update Extensions Models to Conform with New MetaEd Language Changes
  • [ODS-4217] - Remove Grand Bend Extension
  • [ODS-4224] - Make message for unsupported relationship-based authorizations more "user-friendly"
  • [ODS-4246] - Support for Visual Studio 2019
  • [ODS-4344] - Add GrandBend namespace to sandbox client
  • [ODS-4354] - Add GrandBend namespace to test harness client

Bug Fixes

  • [ODS-2959] - ODS API can run on an unexpected port in development environments
  • [ODS-3164] - 3.1 DisciplineIncident: cannot change staffReference
  • [ODS-3543] - 1 second added to CreateDate each time root aggregate is updated
  • [ODS-3572] - Client-Side Bulk Load Utility loads interchange resource types out of order
  • [ODS-3929] - ODS API descriptor cache fails to resolve newly created descriptor if cache is already initialized
  • [ODS-4154] - swagger.json files are generated with the id field marked as required for POST requests
  • [ODS-4188] - Unable to Reference Post Secondary Institution as Education Organization
  • [ODS-4207] - Unable to Retrieve Data From Subclasses of Education Organization
  • [ODS-4223] - Unsafe Singleton Connection String Adapter Fails At High Request Levels
  • [ODS-4236] - Fix SdkCategorizer to Better Filter GetAll Methods
  • [ODS-4264] - Smoke Tests GetByExample fails when attempting to select shorten version of table name
  • [ODS-4265] - Profiles throw an exception on a reference that the parent does not have
  • [ODS-4296] - Primary key conflict due to case sensitivity
  • [ODS-4298] - Issues with PostgreSQL Table/Column Lookup
  • [ODS-4316] - Authorization views for CommunityProvider and CommunityOrganization do not follow required naming conventions
  • [ODS-4322] - BulkLoadClient Crashes on Malformed Xml File

Ed-Fi ODS / API v5.0.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

PosgreSQL backed ODS In ODS API backed by PostgreSQL GET requests fail when a query parameter value is provided for a money type (e.g. Amount on Budget)

ODS-4263 - Getting issue details... STATUS

Project Templates Extension project template includes reference to EdFi.Ods.Xml project which was removed in the current release. Workaround is described in the linked ticket. 

ODS-4652 - Getting issue details... STATUS

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