We would like to announce that we are planning a new major release of OData .NET core libraries in June. Ahead of this release, we have released preview versions of the libraries to get some early feedback from the community. Specifically, the following preview releases are now available on NuGet:<\/p>\n
It has been almost 8 years since the last major release of OData .NET core libraries. This release presents an opportunity for us to modernize our stack, address some technical debt and take better advantage of investments in .NET. To make adoption and upgrading to the new version smooth, we have opted to limit the number of breaking changes. In many cases, you should be able to upgrade to the new release by changing the version number with minimal code changes. We share a list of breaking changes below.<\/p>\n
The most disruptive change we are making in this release is dropping support for .NET Framework. The new release will only support .NET 8 and later. We understand that there are still a lot of people using .NET Framework. For this reason, we will continue to maintain OData .NET v7 suite of libraries for the foreseeable future. We currently have no plans to drop support for OData Core 7.x. We will eventually stop adding new features after the 8.0 major release.<\/p>\n
With this release, we will also introduce an official support policy. The support policy will document the support lifecycle for the different official OData libraries. This will state which versions are supported and for how long and this should help customers plan their migration accordingly. We will also publish a comprehensive migration guide to help you move from version 7.x to 8.0.0.<\/p>\n
We invite you to try out these new versions and share feedback with us. Feel free to create an issue on our GitHub repository<\/a> if you run into any issues with the preview release.<\/p>\n We may release additional preview versions or release candidates before the final release depending on the feedback we get. We also plan to release new versions of Microsoft.AspNetCore.OData and Microsoft.OData.ModelBuilder that take advantage of OData Core 8.x. We will communicate the dates for these releases soon.<\/p>\n The sections below list the breaking changes introduced the preview release. For a full list of changes (including non-breaking changes and improvements), check the changelog<\/a>.<\/p>\n This section contains a list of planned changes that are expected to make it to the official 8.0.0 release that are not available in the first preview.<\/p>\n <\/p>\n","protected":false},"excerpt":{"rendered":" We would like to announce that we are planning a new major release of OData .NET core libraries in June. Ahead of this release, we have released preview versions of the libraries to get some early feedback from the community. Specifically, the following preview releases are now available on NuGet: Microsoft.OData.Core 8.0.0-preview.1 Microsoft.OData.Edm 8.0.0-preview.1 Microsoft.OData.Client […]<\/p>\n","protected":false},"author":20326,"featured_media":3253,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[],"class_list":["post-5629","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-odata"],"acf":[],"blog_post_summary":" We would like to announce that we are planning a new major release of OData .NET core libraries in June. Ahead of this release, we have released preview versions of the libraries to get some early feedback from the community. Specifically, the following preview releases are now available on NuGet: Microsoft.OData.Core 8.0.0-preview.1 Microsoft.OData.Edm 8.0.0-preview.1 Microsoft.OData.Client […]<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/posts\/5629","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/users\/20326"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/comments?post=5629"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/posts\/5629\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/media\/3253"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/media?parent=5629"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/categories?post=5629"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/odata\/wp-json\/wp\/v2\/tags?post=5629"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}OData .NET 8 release schedule<\/h2>\n
\n
Breaking changes in Version 8.0.0-preview.1<\/h2>\n
General breaking changes<\/h3>\n
\n
Breaking changes in
Microsoft.OData.Core<\/code><\/h3>\n\n
IJsonWriter<\/code>,IJsonWriterAsync<\/code>, IJsonStreamWriter<\/code>, IJsonStreamWriterAsync<\/code> into a single interface IJsonWriter<\/code> that exposes synchronous, asynchronous and streaming APIs for writing JSON payloads<\/li>\nIJsonReader<\/code>, IJsonReaderAsync<\/code>, IJsonStreamReader<\/code>, IJsonStreamReaderAsync<\/code> into a single interface IJsonReader<\/code> that exposes synchronous, asynchronous and streaming APIs for reading JSON payloads<\/li>\nleaveOpen<\/code> argument of the ODataBinaryStreamValue<\/code> constructor from true<\/code> to false<\/code>. This means that by default, when the ODataBinaryStreamValue<\/code> object is disposed, the underlying stream will also be closed and disposed.<\/li>\nIJsonWriterFactory.CreateJsonWriter<\/code> method now accepts a Stream<\/code> instead of a TextWriter<\/code>.<\/li>\nDefaultStreamBasedJsonWriterFactory<\/code> class has been renamed to ODataUtf8JsonWriterFactory<\/code>.<\/li>\nIContainerBuilder<\/code> interface used for dependency injection in favor of the standard Microsoft.Extensions.DependencyInjection<\/a> APIs.<\/li>\nAddDefaultODataServices<\/code>to IServiceCollection<\/code> for registering default OData services.<\/li>\nODataSimplifiedOptions<\/code> class and moved its properties to more appropriate classes (see below).<\/li>\nEnableParsingKeyAsSegment<\/code> from ODataSimplifiedOptions<\/code> to ODataUriParserSettings<\/code>.<\/li>\nEnableReadingKeyAsSegment<\/code>\u00a0and\u00a0EnableReadingODataAnnotationPrefix<\/code> from ODataSimplifiedOptions<\/code> to ODataMessageReaderSettings.<\/code><\/li>\nEnableWritingKeyAsSegment<\/code>,\u00a0GetOmitODataPrefix<\/code>\u00a0and\u00a0SetOmitODataPrefix<\/code> from ODataSimplifiedOptions<\/code> to ODataMessageWriterSettings<\/code>.<\/li>\nODataMessageReader.CreateODataDeltaReader<\/code> and CreateODataDeltaReaderAsync<\/code> methods. Use CreateODataDeltaResourceSetReader<\/code> instead.<\/li>\nODataMessageWriter.CreateODataDeltaWriter<\/code> and CreateODataDeltaWriterAsync<\/code> methods. Use CreateODataDeltaResourceSetWriterAsync<\/code> instead.<\/li>\nINavigationSourceSegment<\/code> interface that exposes a NavigationSource<\/code> property to provide a consistent way of retrieving the navigation source without having to perform a type cast.<\/li>\n<\/ul>\nBreaking changes in
Microsoft.OData.Client<\/code><\/h3>\n\n
DataServiceContext.KeyComparisonGeneratesFilterQuery<\/code> property as deprecated and changed the default value from false<\/code> to true<\/code>. This means that the LINQ query context.People.Where(p => p.Id == 10)<\/code> will generate a URL filter query option like \/People?$filter=Id eq 10<\/code> instead of \/People(10)<\/code> by default.<\/li>\nHttpWebRequestMessage<\/code> class, and consequently, support for the legacy HttpWebRequest<\/code><\/a> API. All requests from the client will be made using HttpClientRequestMessage<\/code> which is based on HttpRequestMessage<\/code> <\/a>and HttpClient<\/code><\/a>.<\/li>\nHttpRequestTransportMode<\/code> enum property from DataServiceContext<\/code>. This property was used to switch between HttpClient<\/code> and HttpWebRequest<\/code>. Now all requests are made using HttpClient<\/code>.<\/li>\nDataServiceContext.HttpClientFactory<\/code> property that allows you inject your HttpClient<\/code> instance by passing a custom IHttpClientFactory<\/code>. This replaces the previous approach of configuring a http client using the custom IHttpClientHandlerProvider<\/code> (see below).<\/li>\nDataServiceContext.HttpClientHandleProvider<\/code> property and the IHttpClientHandlerProvider<\/code> interface. These were used to provide custom HttpClient<\/code> configurations. The DataServiceContext.HttpClientFactory<\/code> should be used instead.<\/li>\nDataServiceContext.Credentials<\/code> property. The DataServiceContext.HttpClientFactory<\/code> should be used to provide a HttpClient<\/code> instance configured with the right credentials if needed.<\/li>\nHttpClientRequestMessage.ReadWriteTimeout<\/code> property. The HttpClientRequestMessage.Timeout<\/code> can be used to set the request timeout.<\/li>\nDataServiceQuery<TElement>.IncludeTotalCount(bool countQuery)<\/code> method. Use IncludeCount(bool countQuery)<\/code> instead.<\/li>\nDataServiceQuery<TElement>.IncludeTotalCount()<\/code> method. Use DataServiceQuery<TElement>.IncludeCount()<\/code> instead.<\/li>\nQueryOperationResponse.TotalCount<\/code> property. Use Count<\/code> instead.<\/li>\n<\/ul>\nBreaking changes in
Microsoft.OData.Edm<\/code><\/h3>\n\n
EntityType<\/code> property to IEdmNavigationSource<\/code> interface to make it easier to retrieve the entity type from a navigation source without having to perform a type cast.<\/li>\n<\/ul>\nPlanned changes in Version 8.0.0<\/h2>\n
Planned changes in
Microsoft.OData.Core<\/code><\/h3>\n\n
ODataUtf8JsonWriter<\/code> the default JSON writer implementation.<\/li>\nValueTask<T><\/code> instead of Task<T><\/code> for async I\/O operations where applicable.<\/li>\ninclude-odata-annotations<\/code> preference header.<\/li>\nScale<\/code> attribute in XML CSDL, write variable<\/code> in lowercase instead of Variable<\/code>.<\/li>\nODataLibraryCompatibility<\/code> enum into a flags enum where each bit will represent a different compatibility setting that can be used to enable some legacy serializaiton behaviour.<\/li>\n