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

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

Ed-Fi ODS / API v6.0 - Release Notes

Important Epics

  • [ODS-5335] - Align ODS /API to v4.0a Data Standard
  • [ODS-2571] - Implement Record Ownership Authorization Strategy
  • [ODS-5163] - Change Queries Delete Tracking
  • [ODS-5239] - Update .net framework to version 6
  • [ODS-5263] - Allow combining Authorization Strategies
  • [ODS-5321] - External Cache Feature
  • [ODS-5432] - Destructive SDK SmokeTests

General Improvements & Enhancements

  • [ODS-3415] - Update Security database schema to ensure uniqueness of claim URL
  • [ODS-3536] - Case sensitivity with "Changes" feature
  • [ODS-4021] - Add metadata to claim set records so that Admin App can determine which to present and which to treat as default/read-only
  • [ODS-4916] - Add Health Checks to Applications
  • [ODS-4928] - Update Bootstrap for Sandbox Admin
  • [ODS-5045] - Optimize oauth/token request
  • [ODS-5151] - Make PostgreSQL 13 the minimum supported version
  • [ODS-5221] - Add Postman tests for Record Ownership feature
  • [ODS-5226] - Include main api area base urls in the version endpoint
  • [ODS-5259] - Update security visualization tool to visualize multiple auth strategies
  • [ODS-5285] - Make SQL server 2019 the minimum version
  • [ODS-5289] - Support for Visual Studio 2022
  • [ODS-5291] - Switch to openapi-generator in SdkGen
  • [ODS-5292] - DefaultPageSizeLimit configuration should be used as the page size when limit parameter is not specified
  • [ODS-5293] - Change query delete endpoint paging
  • [ODS-5296] - Bring edorg trigger generation logic to codegen
  • [ODS-5298] - Improve Error Reporting for Bad Connection String
  • [ODS-5301] - Authorization simplifications to filtering architecture to take advantage of EducationToEducationOrganizationId table
  • [ODS-5308] - Clearing expired tokens in background could potentially allow access via expired tokens
  • [ODS-5312] - Move clearing of expired client access tokens to configurable API background task
  • [ODS-5313] - Documentation on provisioning agent jobs for SQL Server and PostgreSQL.
  • [ODS-5326] - Add Modified Date to API GET Responses
  • [ODS-5332] - Rename Logical Files When Creating Sandboxes
  • [ODS-5333] - Postman Tests for Get Many Resources with Multiple Authorization Strategies
  • [ODS-5354] - Add PublishToIIS publish profiles for Swagger and Sandbox Admin
  • [ODS-5355] - Eliminate EdOrg cache and supporting components and tests
  • [ODS-5368] - Investigate and fix dotnet test errors in Unix
  • [ODS-5392] - EdFi API/ODS - IdentitiesController - Improve error handling
  • [ODS-5417] - Web API and Sandbox Installers: Update create Sql login function to prompt for existing credentials
  • [ODS-5424] - Update Tests to run against Postgres
  • [ODS-5435] - Remove namespace from message for Namespace-based authorization failures
  • [ODS-5453] - Change error for Relationship Authorization Strategy Filter to remove USI from error message
  • [ODS-5459] - Create AuthorizationContextDataProvider for role-named ResponsibilitySchoolId in Discipline Action
  • [ODS-5461] - PostgreSQL databases update to 13.7 version
  • [ODS-5462] - Single-item authorization of OrganizationDepartment should use ParentEducationOrganizationId
  • [ODS-5464] - Change Queries MetaEd plugin is incorrectly substituting the extension schema in place of the base table's schema in the SQL Server delete triggers
  • [ODS-5491] - Change GradebookEntry authorization strategy to NamespaceBased
  • [ODS-5497] - Include API Client Id in the logs
  • [ODS-5505] - Enhance Namespace-based authorization to support prefixed Namespaces
  • [ODS-5511] - availableChangeQueries OpenApi Spec definition is incorrect
  • [ODS-5528] - Swagger UI: Disable configUrl and url parameters
  • [ODS-5529] - Nodes should share cached records when using an external cache
  • [ODS-5533] - Index TargetEducationOrganizationId in edorg tuple table

Bug Fixes

  • [ODS-4944] - NHibernate case sensitivity issue could break GET
  • [ODS-4997] - Wrong HTTP response when bulk uploading descriptors with invalid key and secret
  • [ODS-5070] - Getting Incomplete Validation Message for Bad Descriptor Reference for some resources
  • [ODS-5179] - Security visualization utility shows incorrect authorization strategy
  • [ODS-5184] - WebApi Postgres install does not include port number in connection string in appsettings
  • [ODS-5186] - Dependency order endpoints don't list update order
  • [ODS-5270] - Security visualization tool doesn't reflect AuthorizationStrategyOverrides
  • [ODS-5279] - Timeouts when creating Sandboxes with larger dataset
  • [ODS-5294] - Date format in references
  • [ODS-5307] - Unable to bulk upload descriptors to extensions with compound names
  • [ODS-5344] - Stage deployment is failing to create sandboxes
  • [ODS-5388] - performanceEvaluationRatings should use same auth strategy as PerformanceEvaluation
  • [ODS-5391] - Load Test Build is silently failing a test
  • [ODS-5444] - Unable to delete a sandbox in IIS
  • [ODS-5466] - Console bulk loader uses incorrect grant type
  • [ODS-5481] - Improve handling of proxy headers received from AWS Elastic Load Balancer

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

Contents

Find out more about what's new in the latest version of the Ed-Fi ODS / API: