What's New - Release Notes

This section provides a comprehensive list of all the improvements, updates, enhancements, fixes, and changes in the Ed-Fi ODS / API v2.1.1 and v2.1 releases, with links to the relevant issue in the Ed-Fi Tracker.

Ed-Fi ODS / API v2.1.1 - Release Notes

Improvements & Enhancements

[ODS-720] - Integrate MI bulk load enhancements into Ed-Fi core
[ODS-873] - XML Lookup Utility
[ODS-805] - Add resources for localEducationAgency to the enrollment composite API
[ODS-475] - Add Support for Claim Set-specific Authorization Strategy Overrides for Resources
[ODS-770] - Implement support for prefixing database names
[ODS-771] - Provide Types as well as Descriptors in API composites
[ODS-778] - As a API client, I need a way to get all studentAssessments for a particular assessment
[ODS-785] - Domain metadata extensions enhancements for schema handling
[ODS-787] - Support role-named USI columns during code generation
[ODS-836] - Add support for authorization-specific validations
[ODS-847] - Modify Sdk Generation to Create Request Objects for GetByKey and GetByExample
[ODS-851] - Add additional information to email notification from Security Config tool
[ODS-869] - Add support for cache warming on the Person cache
[ODS-870] - Add support for cache warming on the EdOrg cache
[ODS-871] - Types/Descriptor cache enhancements
[ODS-876] - Add entities to track ODS component versioning
[ODS-896] - Add support for async version of SaveChanges in IUsersContext

Bugs Fixed

[ODS-682] - XML shredder doesn't support inlined collections of non-string values
[ODS-683] - XML shredder doesn't call method to strip EXTENSION naming artifacts when determining PropertyTypeName for string collections
[ODS-685] - Unable to insert any records to ReportCard when grade reference included
[ODS-729] - Edfi_Security allows Null Authorization Strategy
[ODS-731] - Fix Gaps in Foreign Key Inverse Indexes
[ODS-760] - XML Shredder does not apply role names to UniqueId properties
[ODS-761] - Previous login to sandbox throws a "Yellow Screen of Death" after Admin database reset
[ODS-766] - TypeLookupProvider causes SQL query timeouts when no Type data is present
[ODS-788] - Code generation doesn't handle key unification on Types/Descriptors correctly
[ODS-813] - ODS/APi CI environment - sandboxes appear to be in "error" state after migration
[ODS-815] - Security Claim Authorization Doesn't Fully Support Hierarchy
[ODS-831] - Verify redundant claims on "Assessment Vendor" claim set
[ODS-834] - Clean Up Extra Claims Originally Required by Security Hierarchy Bug
[ODS-835] - Server Error If Security is Unable to Resolve Data Required in Relationship Strategy
[ODS-838] - Issue with Core InterchangeOrderMetadata.xml Order
[ODS-841] - StudentSpecialEducationProgramAssociation in Profile with memberSelection=IncludeOnly or memberSelection=ExcludeOnly throws NullReferenceException in build
[ODS-846] - Sdk Generation Generates Bulk/Identity Related Files to Every Namespace
[ODS-850] - Calling API without the "Authorization" header results in an "Internal Server Error"
[ODS-855] - When using initdev the populated and minimal templates are named improperly
[ODS-862] - Removing databases fails in some edge cases
[ODS-863] - Data loss can be caused by misconfiguration of a sandbox environment
[ODS-881] - Database Configuration Transform Isn't Being Applied in Octopus Deploy
[ODS-884] - Typo on LanguageDescriptor causing vendor an error when posting thru API
[ODS-893] - Update LoadGeneration Utility To Reflect Modified Default Namespace
[ODS-895] - Edfi Admin Website Is Not Logging Unhandled Exceptions
[ODS-897] - API produces HTTP Response-Code 500 (staffSchoolAssociations, staffSectionAssociations)
[ODS-899] - Put for Student Doesn't Correctly Update StudentLanguage and StudentLanguageUse
[ODS-902] - API produces HTTP Response-Code 500 (Programs, CalendarDates)
[ODS-908] - Authorization issue on CI staging
[ODS-912] - Load Generation utility report incomplete
[ODS-914] - Timeouts In Slower Environments When Creating Sandboxes
[ODS-915] - Data in dbo.VersionLevel in Populated Template DB is incorrect
[ODS-891] - Update Populated Database with 'Hindi' value change
[ODS-877] - Clean Up Old Branches in Git
[ODS-843] - Review need for /Application/DeveloperSetup artifacts
[ODS-842] - 0008-StoredProcedures.sql - Review and remove obsolete stored procedures from ODS database setup
[ODS-937] - Extra Submodule Reference In EdFi ODS Repository Needs to Be Deleted

Ed-Fi ODS / API v2.1 - Release Notes

API Composite Resource Feature

[ODS-588] - Integrate API Composites into ODS development branch
[ODS-793] - Composite API: Add resource ID to the LocalEducationAgency reference in the /schools resource
[ODS-794] - Add StudentSectionAssociation.id and StaffSectionAssociation.id to /section and /sectionEnrollment
[ODS-795] - Surface student.loginId and staff.loginID in the roster /student and /staff resources, respectively
[ODS-804] - Provide additional claim sets in default ODS/API install
[ODS-803] - Composite API: If multiple values for fields parameter, spaces at end will cause unexpected error

Release Note

While the API Composite Resources feature is an addition to the Ed-Fi ODS / API, a side effect is to apply stricter expectations for extensions. This may result in build errors if extensions do not fully adhere to the guidelines for Extending the ODS / API Data Model.

If implementations encounter this situation and need to continue to use existing extensions, the API Composite Resources feature can be disabled from building by setting the the build property to "None" for for the following files:

EntitiesForQueries.generate.cs in the EdFi.Ods.Entities.NHibernate project
EntityOrmMappingsForQueries.generated.cs in the EdFi.Ods.Entities.NHibernate.Mappings.SqlServer project

Improvements & Enhancements

[ODS-208] - Make Azure SDK optional
[ODS-478] - Improved info on "natural key conflict" error messages
[ODS-596] - Update Swagger UI to show popup error when authorization fails
[ODS-665] - Remove legacy bulk load upload from solution
[ODS-670] - Make database restoration process more resilient to non-default SQL installations
[ODS-671] - Bulk load services generate massive logs under some conditions
[ODS-700] - Add VS 2015 support - part 1
[ODS-701] - Remove requirement for use of development certificate
[ODS-709] - Add VS 2015 support - part 2
[ODS-725] - EdFi.Ods.Api.Models project doesn't use nuget package for reference to System.Web.Http
[ODS-726] - EdFi.Ods.SecurityConfiguration.Services project doesn't use nuget for EntityFramework reference
[ODS-739] - Standardize Logging Configuration
[ODS-740] - Disable EnableSystemDiagnosticsTracing
[ODS-747] - Modify the /TestUsers/Initialize step to give feedback to the user
[ODS-806] - Add missing security/authorization tests.
[ODS-811] - Set up Sandbox Claimset
[ODS-812] - Update sample data to Grand Bend data set for the ODS
[ODS-592] - Load Testing Utility V2 Phase 1
[ODS-743] - Check-in File Uploader Source Code

Bugs Fixed

[ODS-623] - ODS doesn't validate 1 to Many sub relationships
Release Note

An effect of fixing this bug is to validate that additional data (required per the Ed-Fi data standard) is supplied in affected resources. This may impact existing client API applications that are not supplying all required data. See the Ed-Fi Tracker ticket referenced above for more details.
[ODS-561] - Missing Indexes on Entities for ID.
[ODS-568] - Profile validation
[ODS-575] - Join column mismatch occurs on aggregate child entity when role name applied to an incoming relationship that is part of the composite primary key
[ODS-597] - Swagger unable to handle profiles including aggregate resources and descriptors
[ODS-619] - SandboxProvisionerTypeCalculator/SqlSandboxProvisioner still assume web server and database server are the same machine
[ODS-621] - Dashboard Compatibility Views - InitDev in API Project fails with Compatibility Type Inserts SQL script
[ODS-622] - 500 error due to a null reference - being thrown by AssessmentMetadataAuthorizationStrategy.cs
[ODS-624] - Unable to insert any records to ObjectiveAssessmentLearningObjective
[ODS-625] - Null Post requests or requests that can't be de-serialized successfully cause a null reference (500 error)
[ODS-629] - Passing an explicit null for any collection (optional or not) causes a 500 server error
[ODS-630] - Too many requests cause all requests to fail if security repo hasn't had chance to cache
[ODS-663] - Content Difference for Descriptor Namespace
[ODS-673] - Seed Method for Edfi_Admin Attempts to Save While Enumerating
[ODS-674] - PostChunk Not Waiting For Stream Processing to Finish
[ODS-675] - ODS/API Swagger documentation update
[ODS-676] - ContentType is Being Required when Profiles Authorization Filter is Enabled
[ODS-680] - Sample Assessments and StudentAssessments do not work in the ODS 2.0 API using the default sandbox database
[ODS-684] - Code generation template for EntityAuthorizationContextProviders produces compilation error for empty arrays
[ODS-714] - BulkUploadDemo project doesn't use nuget package for reference to System.Net.Http.Formatting
[ODS-723] - Adjust Edfi_Admin Database Context Lifecycle To Fix Concurrency Issues
[ODS-724] - Dangerous text validation raises errors on legitimate values
[ODS-727] - StaffSchoolAssociation - SchoolYear relationship missing FK
[ODS-741] - Sandbox Admin client error when attempting to create a sandbox
[ODS-745] - Error: "HttpException was unhandled by user code"
[ODS-746] - Update text in Web API "home page" - to remove reference to "technical preview"
[ODS-750] - Disable ProfileDefinitionsCanIncludeAndExcludeCertainReferencesOnResourcesFeature
[ODS-752] - Managed Descriptors have invalid namespaces in the ODS 2.0 API using the default sandbox database
[ODS-759] - Cascades on StudentSectionAssociation are disabled
[ODS-765] - Seeing API Memory usage escalating during day until app pool is recycled at night
[ODS-768] - Fix Student Transcript Extensibility sample
[ODS-776] - Case issues cause errors in 'q' query parameter in assessment composite API
[ODS-797] - Composite API: Correct Swagger metadata and API handling of single item responses for composites
[ODS-798] - Get Token option from Sandbox Admin Portal fails (CI environment)
[ODS-808] - Admin database on CI staging server has out of date information
[ODS-826] - Encountering compile error when generating the SDK
[ODS-828] - API Profiles - Error Adding StudentSpecialEducationProgramAssociation

Documentation

[ODS-656] - Documentation - How to remove EdOrg sample data from EdFi_Ods_Minimal_Template
[ODS-661] - Documentation: How do you test Bulk worker and Upload worker Services?
[ODS-689] - Update Extensions documentation to cover need for additional shredder metadata file
[ODS-712] - Document removal of requirement for use of development certificate
[ODS-734] - Request for documentation on API profiles implementation
[ODS-814] - Release documentation