What's New - Release Notes

This section provides a comprehensive list of all the improvements, updates, fixes, and changes in the Ed-Fi ODS / API v3.0 Technical Preview release, with links to the relevant issue in the Ed-Fi Tracker.

Ed-Fi ODS / API v3.0 Tech Preview (a) - Release Notes

API 3.0 Enhancements

The major enhancements are covered by the following Epics:

• [ODS-1363] - ODS_API 3.0: API Futures Enhancements
• [ODS-1395] - SwaggerUI Alignment and API Sections support
• [ODS-1668] - ODS_API 3.0: API Futures Enhancements - Stability

Data Standard Support

Support for alignment to the latest Ed-Fi Data Standard is covered by the following Epics:

• [ODS-1121] - ODS_API 3.0: Align ODS/API to v2.1 Data Standard
• [ODS-1695] - ODS_API 3.0: Align ODS/API to v3.0a Data Standard

General Improvements & Enhancements

Noteworthy improvements and enhancements include:

• [ODS-1747] - Make proxy headers configurable in the OpenApiMetadataController
• [ODS-1007] - Remove Test Strongly Coupled To Core Descriptors
• [ODS-1036] - Remove Extraneous Indexes from Sql Schema
• [ODS-1122] - Remove Identity Claim from SIS Vendor Claimset
• [ODS-1220] - Improve Swagger performance and Authorization
• [ODS-1370] - Improve extensibility of IOAuthTokenValidator
• [ODS-1374] - Enable Demo Auto Refresh Nightly of Sandbox
• [ODS-1744] - Add version information to the API landing page
• [ODS-1005] - Remove EnsureAllConnectionsClosed function from DatabaseSchemaProvider
• [ODS-1124] - Add an optional setting to increase timeouts during sandbox creation
  
  

Ed-Fi ODS / API v3.0 Tech Preview (b) - Release Notes

Data Standard Support

Support for alignment to the latest Ed-Fi Data Standard is covered by the following Epics:

• [ODS-1818] - ODS_API 3.0: Align ODS/API to v3.0b Data Standard

General Improvements & Enhancements

Noteworthy improvements and enhancements include:

• [ODS-1805] - Integrate fixes in v2.3.1 into /development-v3
• [ODS-1802] - Remove "Types" from SDK NuGet
• [ODS-790] - OpenStaffPosition primary key contains more columns than necessary to achieve unique identification
• [ODS-1123] - Create claims for the bulk API endpoints
• [ODS-1583] - Modify flat file versions of Identity and Bulk specs to store as json instead of resx
• [ODS-1584] - Review Application Startup Time
• [ODS-1667] - Use SQL Server Table-Valued Parameters for IN clauses in the API
• [ODS-1769] - API Futures - need to support creating composites under different organizations than Ed-Fi
• [ODS-931] - Get By Example throws internal server error when Id and Key values are supplied
• [ODS-1723] - Queue Locator Invalid for Remote Queue
• [ODS-1777] - Memory Leak - Incorporate profile controller lifestyle fix to ODS core - v3
• [ODS-1778] - 2.3 SwaggerMetadata.tt runs into duplicate keys with the following example - v3 Verification
• [ODS-1797] - Initdev errors when trying to apply both extension samples
• [ODS-1799] - Remove "Types" section from Swagger
• [ODS-1810] - swagger-code gen issues
• [ODS-1811] - swagger code gen issues - Identities API
• [ODS-1828] - Composites - Parameterized gets are not working in Swagger
• [ODS-1839] - Move Core Xsd Files to Ed-Fi-ODS/Standard/Schemas
  
  

Ed-Fi ODS / API v3.0 Tech Preview (c) - Release Notes

API 3.0 Enhancements

The major enhancements are covered by the following Epics:

• [ODS-1668] - ODS_API 3.0: API Futures Enhancements - Stability

Data Standard Support

Support for alignment to the latest Ed-Fi Data Standard is covered by the following Epics:

• [ODS-1900] - ODS_API 3.0: Align ODS/API to v3.0c Data Standard

General Improvements & Enhancements

Noteworthy improvements and enhancements include:

• [ODS-1908] - Expose Detailed Version Information from API
• [ODS-1928] - Utilities: Update the Utilities for API futures work (Client Side Bulk loader, Smoke Test, xml Lookup Utility)
• [ODS-827] - Extensions to Derived Domain Entities or Associations Do Not Persist in the ODS
• [ODS-929] - Issuing GetByExample on StudentSchoolAssociation with an invalid studentuniqueid returns incorrect data
• [ODS-1477] - Fix codegen unifying key values from optional references
• [ODS-1535] - 500 error attempting to POST staff when not authenticated on Staging
• [ODS-1795] - Add authorization for CommunityProviderIdToLocalEducationAgencyId
• [ODS-1820] - Apply Assessment Security Fixes from 2.3.1 to 3.0 API
• [ODS-1826] - Open API Specification Doesn't Pass Schema Validation
• [ODS-1884] - Client Side Bulk Loader Mapper Changes - for swagger spec updates
• [ODS-1886] - Version is missing in Identity API route
• [ODS-1891] - Merging entity extension property with core property of same name
• [ODS-1940] - GradeLevel is not being mapped correctly in by the ApiLoader.Console.Exe tool
• [ODS-1664] - Remove JSON object and field naming simplifications
• [ODS-1693] - Surface a default operational context when key/secrets are assigned to API clients
• [ODS-1692] - Require namespaces for descriptors for all API transactions, and require them in a structured format
• [ODS-1744] - Add version information to the API landing page
• [ODS-1848] - Update enrollment composite API definition for 3.0
• [ODS-1849] - Update assessment composite API definition
• [ODS-1912] - Refinements to API routes for API v3
  
  

Ed-Fi ODS / API v3.0 RC1 - Release Notes

API 3.0 Enhancements

The major enhancements are covered by the following Epics:

• [ODS-1902] - Implement Bulk Loading Extensions in API 3.0
• [ODS-532] - Replace key and secret algorithms with cryptographic algorithms
• [ODS-535] - Secure the Key and Secret information in the Ed-Fi Admin database
• [ODS-1897] - Expose natural key fields in Swagger for 3.0 API
•  [ODS-1495] - Swagger - visibility to lengths for string data types

Data Standard Support

Support for alignment to the latest Ed-Fi Data Standard is covered by the following Epics:

• [ODS-2004] - ODS_API 3.0: Align ODS/API to v3.0RC Data Standard

General Improvements & Enhancements

Noteworthy improvements and enhancements include:

• [ODS-1117] - Swagger UI Site Hosted In IIS Virtual Directory Requires Trailing Slash
• [ODS-1285] - Swagger - provide ability to toggle between school years
• [ODS-1192] - sexType is case sensitive
• [ODS-1394] - Ed-Fi Ods Database is not available
• [ODS-1728] - Deployment Fails Intermittently Due to Locked EdFi_Admin Database
• [ODS-1379] - EducationOrganizationId did not get populated correctly in StudentProgram bulk load
• [ODS-1532] - Shared resource ID issue
• [ODS-1821] - Ensure TPDP Bulk Loading Scenario With Extensions Works in 3.x
• [ODS-1323] - TNTP/TPDP -Facts leads to errors between multiple/singular
• [ODS-1822] - Build-Deployment is not detecting Smoke Test Utility failures - V3.0
• [ODS-1859] - Model Existing Sample and GrandBend Implementation Extensions in MetaEd
• [ODS-1924] - Under 3.0 the composite API Swagger shows each Property as a parameter
• [ODS-1925] - In 3.0 API parameter that appears in Composite API Swagger causes error when used
• [ODS-1943] - Issuing invalid descriptor id on getStudents results in Internal server error
• [ODS-1947] - Reset-PopulatedTemplateFromSample Is Including Extension Scripts
• [ODS-1955] - Polish for built in extensions - add swagger description metadata
• [ODS-1963] - Queryable specification parameters not working in API composites under 3.0
• [ODS-1983] - Sandbox Admin: Unable to create sandbox
• [ODS-2008] - Compound keys where property is a string - issues with leading, trailing spaces
• [ODS-1850] - Support custom authorization context for relationship-based authorization based on non-PK and/or role-named columns
• [ODS-1857] - Build Time Failure For Invalid Composites Xml
• [ODS-1973] - Update swagger-ui to version 3.12.0
• [ODS-1974] - Enable vendor extensions in the swagger-ui application
• [ODS-2022] - Upgrade Nuget Packages to most recent versions
• [ODS-2067] - Fix StudentTranscript Example according to Extension Framework guidelines
• [ODS-175] - Remove 202 status codes?
• [ODS-1735] - Credential Security Decisions
• [ODS-1833] - Remove SemanticModels Projects
• [ODS-1835] - Consolidate All Artifacts Into Extension Project

Ed-Fi ODS / API v3.0 Release Candidate - Known Issues

The table below identifies key areas of functionality that are known to have issues  in the Release Candidate.

For a full list of open tickets that are planned for completion in the final v3.0 release, view this link*:  Getting issues...

*Viewing Ed-Fi tracker tickets requires a login.