v3.0 Tech Preview - Updates & Breaking Changes

Data Standard Support

• Review any current Extensions to see if additional elements are included in the new Data Standard. 

• Apply and test Extensions, coordinate roll-out and support with API consumers though data governance, sandbox testing, and so forth.

• Review client application API interactions for breaking changes in JSON payloads due to data model changes.

Ed-Fi Extension Decoupling

• Review new Extension capabilities. For example, Extension decoupling supports an Ed-Fi Core plus composable Ed-Fi Extensions.* The draft articles How To: Extend the Ed-Fi ODS / API - Student Transcript Example (Tech Preview) and How To: Extend the Ed-Fi ODS / API - Student Transportation Example (Tech Preview) have detail.

• Platform hosts can also apply multiple Extensions, such as host-specific extensions (e.g., an SEA-specific accountability collection), along with domain-specific extensions (e.g., talent management, transportation).

• Review new Extension capabilities.

• Client system developers will need to accommodate any platform changes or enhancements in API integration code.

Swagger / Open API Updates

• Review new documentation and sandbox capability.

• If applicable (e.g., if developers have used the customized Ed-Fi SDKs for C# or Java), migrate to the latest standard Swagger Codegen client SDK tooling compatible with OpenAPI 2.0. 

• If applicable (e.g., if developers have used the GetByKey or GetByExample), modify code to adapt to standardized return types for GETs.

Standard OAuth 2.0 Alignment

• Review and understand standard OAuth 2.0 Client Credentials Grant Flow.

• Adapt client code to request a new access token upon token expiration.

• This requirement will likely be familiar to developers using OAuth 2.0 in other implementations. The ODS / API v3.0 removes the previous non-standard OAuth implementation, which included a rolling expiration for tokens.

Descriptor References Require Namespaces

• Review and consume the updated code.

• Review all Ed-Fi Descriptors, ensure any localized Descriptors (i.e., those with values other than the as-shipped Ed-Fi Descriptor sets) adhere to the fully qualified namespace pattern. An overview of the feature and the namespace naming requirements is available in the New & Improved Features section of the Feature & Change Summary documentation.

• Publish updated documentation, notify client systems.

• Adapt client code to new specifications.

Code Refactoring

• Review and consume the refactored code.

• If applicable, re-apply customizations.

• No impact.