Edit

Share via

OData lib 8.x changelog

OData lib is loosely used to refer to the following group of OData libraries available on the Nuget gallery:

You can install or update any of the NuGet packages for OData lib using the Package Manager Console.

8.4.0

  • Upgraded version of Windows used on the build pipelines from 2019 to 2022 #3320
  • Apply the relevant network isolation policy settings on the build pipelines #3337 & #3341
  • Removed unpruned references #3335

Microsoft.OData.Core

  • Add support for unquoted types parameter in isof and cast URI functions #3317
  • Add support for parsing custom query options when present on the OData URI #3318
  • Support unencoded slash inside quoted literals such that it's treated as data rather than path segment separators #3340

Microsoft.OData.Core

  • Deprecated IEdmOperation.ReturnType #3330

8.3.0

Microsoft.OData.Core

  • Optimize ODataNullValue allocations with singleton implementation #3284
  • Support parameter aliases in key segments #3278
  • Support more kinds of relative context URIs #3235

8.2.4

Microsoft.OData.Core

  • Optimize ODataNullValue allocations with singleton implementation #3284
  • Handle null segment type when validating URL #3276
  • Avoid redundant verifications when appending new resource properties #3269
  • Allow filtering models using Contains with Enum collections #3253
  • Update .NET 9.0 Public API #3271
  • Enable $root path #3157
  • Resolve FormatException when generating strings using Error.Format or string.Format #3241
  • Enable serialization/deserialization of navigation properties with count and no content #3155
  • Update build pipeline and PR template to reflect CI build instructions #3243
  • Set ElementTypeReference from current navigation property #3239
  • FunctionCallBinder returns SingleValueFunctionCallNode for complex types #3234
  • Support Average aggregation method for Int16 in UriParser #3168
  • Remove vulnerable and unused assemblies #3211
  • Enable $select=colProperty/$count query option parsing #3175
  • Fix $filter for collection of dynamic primitive values #3190
  • Migrate code signing to ESRPv5 #3184
  • Update NuGet release notes changelog URL #3179
  • Add net9.0 support #3171
  • Add README to .nuspec #3152
  • Replace usage of resource files for error messages #3146
  • Port E2E tests to 8.0 in #3042, #3046, #3048, #3251, #3223, #3231, #3225, #3220, #3210, #3208, #3202, #3203, #3164, #3195, #3194, #3187, #3180, #3177, #3176, #3163, #3169, #3161, #3160, #3159, #3172, #3167, #3156

Microsoft.OData.Edm

  • Fix IEdmModel.GetTargetPath type cast error for properties named Geography #3218
  • Fix endless loop when Schema tag has no correct xmlns value #3192

Microsoft.OData.Client

  • Track DependsOnIds when UseJsonBatch flag is applied to batch requests #3272

8.2.3

Microsoft.OData.Core

  • Remove #if NETCOREAPP directives after migrating to .NET 8 #3128
  • Update package metadata to address security vulnerability #3129
  • Allow responses without an associated entity set #3137
  • Include README in NuGet package #3143
  • Fix ArgumentNullException for $filter=property in [''] expression #3122
  • Support parameter aliases in key segments 3278
  • General code cleanup #3142
    • Remove backup files
    • Remove outdated .NET Core-related code
    • Add Microsoft.CodeAnalysis.NetAnalyzers for static code analysis

Microsoft.OData.Client

  • Add DependsOnId parameter in AddRelatedObject API #3079
  • Mark Timeout property as obsolete and recommend using IHttpClientFactory #3135

8.2.2

Microsoft.OData.Core

  • Continue replacing substring in HttpHeaderValueLexer to resolve parsing issue #3097
  • Throw exception when an undefined enum member is used with the in operator #3125
  • Revert fix for isof with unquoted type parameters due to regression #3126

Microsoft.OData.Edm

  • Fix line number reporting when parsing CSDL with multi-line reference elements #3118
  • Prevent StackOverflowException when retrieving navigation partners in large CSDL models #3121

8.2.1

Microsoft.OData.Edm

  • Report accurate line numbers for multi-line elements in payloads #3115

8.2.0

Microsoft.OData.Core

  • Add writer validation tests for failure scenarios #3083
  • Optimize string handling by replacing new string(...) with ReadOnlySpan<char> #3077
  • Remove incorrect target framework in NuGet specification #3096
  • Improve expression support for dynamic properties #3091
  • Do not force flush when ODataUtf8JsonWriter buffer threshold is reached #3102
  • Fix unquoted type parameters in isof expressions #3108

Microsoft.OData.Client

  • Fix issue where entity with enum key could not be attached to DataServiceContext #3106

8.1.0

Microsoft.OData.Core

  • Fix code coverage analysis in test projects #3074
  • Enable support for DateOnly and TimeOnly primitives #3078

Microsoft.OData.Edm

  • Fix issue when writing large metadata documents asynchronously #3081
  • Update Core Vocabulary to include IsDelta term #3087

8.0.2

Microsoft.OData.Core

  • Support type cast in group in #3041
  • Update message writer and reader to ignore Message info from DI #3058
  • Add support for "Any" and Predicates method call expressions in #3061
  • Isolate scoped settings in default OData services in #3071
  • Port E2E tests to 8.0 in #3042, #3046, #3048
  • Add ODataPathInfo tests by @gathogojr in #3053

8.0.1

Microsoft.OData.Core

  • Fix error that occurs when you check whether a string or integer literal is in an enum collection in #3039
  • Fix argument null exception during projection when expanded navigation property is null in #3038

8.0.0

Microsoft.OData.Core

  • Add Microsoft.Extensions.Http dependency in #3035
  • Replace IsType using IsOf to align with the OData standard in #3025
  • Remove obsolete ReadUntypedAsString and address string comparison warnings in #3024
  • Support enum as integer value (enclosed and not enclosed with single quotes) in $filter in #3018
  • Port E2E tests in #3017, #3028
  • Support enums as keys in OData client in #3013
  • Provide async APIs for CsdlWriter and SchemaWriter in #3006
  • Remove references to ATOM in #2972

8.0.0-rc.1

Microsoft.OData.Core

  • Made ODataUtf8JsonWriter the default JSON writer implementation to enhance serialization performance. Benchmarks and feedback from some OData users have shown that ODataUtf8JsonWriter offers better performance and memory efficiency compared to the current default JsonWriter.
  • Changed the ODataLibraryCompatibility enum into a flags enum, where each bit represents a different compatibility setting that can enable some legacy serialization behavior.
  • Refactored ODataError, ODataErrorDetail and ODataInnerError classes.
    • The ODataErrorDetail’s ErrorCode property updated to Code
    • The initialization of ODataInnerError changed to ODataInnerError(new Dictionary<string, ODataValue>())
  • The ODataResource.Properties property type was changed to IEnumerable<ODataPropertyInfo> to facilitate metadata reading or writing, even in scenarios where the property lacks a value.
  • When writing the Scale attribute in XML CSDL, use variable in lowercase instead of Variable. An enum flag, UseLegacyVariableCasing, was added to support the legacy behavior.

Microsoft.OData.Edm

  • Added UsesDefault property to IEdmVocabularyAnnotation to support creating vocabulary annotations without explicit values but with default values. These default values are not written to the CSDL but can be read.

Microsoft.OData.Client

  • Renamed IBaseEntityType.Context to DataServiceContext to avoid naming conflicts that cause compilation or runtime errors when Context is used as a property name in customer schemas.

8.0.0-preview.1

Starting version 8, OData lib will only target .NET 8 or later.

Microsoft.OData.Core

  • IJsonReaderAsync interface has been merged into IJsonReader interface.
    • Any implementation of IJsonReader needs to implement methods previously defined in IJsonReaderAsync interfaces.
    • The Value property in IJsonReader interface is replaced by GetValue method.
  • IJsonReaderFactoryAsync interface has been dropped.
  • IJsonStreamWriter, IJsonWriterAsync and IJsonStreamWriterAsync interfaces have been merged into IJsonWriter interface.
    • Any implementation of IJsonWriter needs to implement methods previously defined in IJsonStreamWriter, IJsonWriterAsync and IJsonStreamWriterAsync interfaces.
  • IStreamBasedJsonWriterFactory and IJsonWriterFactoryAsync interfaces has been dropped.
  • DefaultStreamBasedJsonWriterFactory class has been renamed to ODataUtf8JsonWriterFactory.
  • CreateJsonWriter(TextReader, bool) defined in IJsonWriterFactory has changed to CreateJsonWriter(Stream, bool, Encoding). The method now accepts a Stream rather than a TextReader.
  • List<ODataUrlValidationMessage> Messages property defined in ODataUrlValidationContext class has changed to IReadOnlyList<ODataUrlValidationMessage> Messages.
    • AddMessage(ODataUrlValidationMessage) overload introduced in ODataUrlValidationContext.
  • INavigationSourceSegment interface introduced. The purpose of this new interface is to reduce casting when determining the navigation source associated with the segment. EntitySetSegment, SingletonSegment and NavigationPropertySegment implement this new interface.
  • Deprecated support for JSONP callback. Feature to be removed in ODL 9.
    • JsonPCallback property defined in ODataMessageWriterSettings class marked as obsolete.
    • StartPaddingFunctionScope method defined in IJsonWriter interface marked as obsolete.
    • EndPaddingFunctionScope method defined in IJsonWriter interface marked as obsolete.
    • WritePaddingFunctionName method defined in IJsonWriter interface marked as obsolete.
    • StartPaddingFunctionScopeAsync method defined in IJsonWriter interface marked as obsolete.
    • EndPaddingFunctionScopeAsync method defined in IJsonWriter interface marked as obsolete.
    • WritePaddingFunctionNameAsync method defined in IJsonWriter interface marked as obsolete.
  • ODataSimplifiedOptions class was dropped. This class would be injected into the DI container and the settings used to control behaviour when parsing URLs, and when writing and reading payloads. In ODL 8, ODataMessageReaderSettings, ODataMessageWriterSettings, and ODataUriParserSettings may variously be used to accomplish the same purpose.
    • EnableReadingKeyAsSegment and EnableReadingODataAnnotationWithoutPrefix properties moved to ODataMessageReaderSettings class.
    • EnableWritingKeyAsSegment property moved to ODataMessageWriterSettings class.
    • SetOmitODataPrefix(bool), SetOmitODataPrefix(bool, ODataVersion), GetOmitODataPrefix(), and GetOmitODataPrefix(ODataVersion) methods moved to ODataMessageWriterSettings class.
    • EnableParsingKeyAsSegment property moved to ODataUriParserSettings class.
  • In ODL 7, when ODataBinaryStreamValue class is initialized using the ODataBinaryStreamValue(Stream) constructor, the stream is left open by default upon the object being disposed. In ODL 8, the stream is closed by default the object objects is disposed. The ODataBinaryStreamValue(Stream, bool) constructor overload may be used where leaving the stream open is intended.
  • Func<string, bool> ShouldIncludeAnnotation property introduced in ODataMessageWriterSettings. This property makes it possible for developers to force a custom instance annotation to be written even if it's not include in the optional @odata.include-annotations preference token in Prefer request header.
  • IContainerBuilder interface used when registering OData services was dropped. Use Microsoft.Extensions.DependencyInjection library instead.
    • AddDefaultODataServices(IServiceCollection, ODataVersion, Action<ODataMessageReaderSettings>, Action<ODataMessageWriterSettings>, Action<ODataUriParserSettings>) extension method introduced for the purpose of registering OData services.
    • IContainerProvider interface replaced by IServiceCollectionProvider interface. It's a provider for the IServiceProvider IoC container.
    • ODataBatchOperationRequestMessage now implements IServiceCollectionProvider instead of IContainerProvider.
    • ODataBatchOperationResponseMessage now implements IServiceCollectionProvider instead of IContainerProvider.

Microsoft.OData.Client

  • HttpWebRequestMessage class has been dropped - effectively dropping support for HttpWebRequest. Use HttpClientRequestMessage class instead.
  • IHttpClientHandlerProvider interface used to provide HttpClientHandler for use with DataServiceContext has been dropped.
  • HttpClientHandlerProvider property defined in DataServiceClientRequestMessageArgs class and used for providing HttpClientHandler substituted with HttpClientFactory property that accomplishes the same purpose.
  • HttpClientHandlerProvider property defined in DataServiceContext class and used for providing HttpClientHandler substituted with HttpClientFactory property that accomplishes the same purpose.
  • Obsolete Credentials property dropped from DataServiceClientRequestMessage abstract class. The recommended way to configure credentials is through HttpClientHandler that can be provided using IHttpClientFactory.
  • Obsolete Credentials property dropped from HttpClientRequestMessage class. The recommended way to configure credentials is through HttpClientHandler that can be provided using IHttpClientFactory.
  • Obsolete Credentials property dropped from DataServiceContext class. The recommended way to configure credentials is through HttpClientHandler that can be provided using IHttpClientFactory.
  • Obsolete ReadWriteTimeout property dropped from DataServiceClientRequestMessage abstract class. This property would be used with HttpWebRequestMessage. Timeout property may be used instead.
  • Obsolete ReadWriteTimeout property dropped from HttpClientRequestMessage class. This property would be used with HttpWebRequestMessage. Timeout property may be used instead.
  • In DataServiceClientRequestMessageArgs class, the DataServiceClientRequestMessageArgs(string, Uri, bool, bool, IDictionary<string, string>) constructor has changed to DataServiceClientRequestMessageArgs(string, Uri, bool, IDictionary<string, string>). The boolean useDefaultCredentials parameter is no longer supported.
  • In DataServiceClientRequestMessageArgs class, the DataServiceClientRequestMessageArgs(string, Uri, bool, bool, IDictionary<string, string>, IHttpClientHandlerProvider) constructor has changed to DataServiceClientRequestMessageArgs(string, Uri, bool, IDictionary<string, string>, IHttpClientFactory). The boolean useDefaultCredentials parameter is no longer supported.
  • In DataServiceClientRequestMessageArgs class, the UseDefaultCredentials property dropped from DataServiceClientRequestMessageArgs class. The recommended way to configure credentials is through HttpClientHandler that can be provided using IHttpClientFactory.
  • HttpRequestTransportMode enum property was dropped from DataServiceContext. This property was used to switch between HttpClient and HttpWebRequest that was dropped.
  • KeyComparisonGeneratesFilterQuery flag defined in DataServiceContext class marked as deprecated. Flag will be removed in ODL 9.
    • Default value for keyComparisonGeneratesFilterQuery flag set to true such that a Where expression with only the key property in the predicate is translated into a $filter query rather a resouce URL for requesting a single entity.
  • Obsolete IncludeTotalCount() method was dropped from DataServiceQuery<TElement> class. Use IncludeCount() method.
  • Obsolete IncludeTotalCount(bool) method was dropped from DataServiceQuery<TElement> class: Use IncludeCount(bool) the method.
  • Obsolete TotalCount property was dropped from QueryOperationResponse class. Use Count property.
  • Obsolete TotalCount property was dropped from QueryOperationResponse<T> class. Use Count property.
  • Obsolete CreateODataDeltaReader(IEdmEntitySetBase, IEdmEntityType) method dropped from ODataMessageReader class. Use CreateODataDeltaResourceSetReader(IEdmEntitySetBase, IEdmStructuredType) method.
  • Obsolete CreateODataDeltaReaderAsync(IEdmEntitySetBase, IEdmEntityType) method dropped from ODataMessageReader class. Use CreateODataDeltaResourceSetReader(IEdmEntitySetBase, IEdmStructuredType) method.
  • Obsolete CreateODataDeltaWriter(IEdmEntitySetBase, IEdmEntityType) method dropped from ODataMessageReader class. Use CreateODataDeltaResourceSetWriter(IEdmEntitySetBase, IEdmStructuredType) method.
  • Obsolete CreateODataDeltaWriterAsync(IEdmEntitySetBase, IEdmEntityType) method dropped from ODataMessageReader class. Use CreateODataDeltaResourceSetWriterAsync(IEdmEntitySetBase, IEdmStructuredType) method.
  • Obsolete Expressions property dropped from AggregateToken class. Use AggregateExpressions property.
  • Obsolete Expressions property dropped from AggregateTransformationNode class. Use AggregateExpressions property.
  • Obsolete EntityTypeInvalidKeyKeyDefinedInBaseClass validation rule dropped from ValidationRules class. Use EntityTypeInvalidKeyKeyDefinedInAncestor validation rule.
  • Obsolete EntityTypeKeyMissingOnEntityType validation rule dropped from ValidationRules class. Use NavigationSourceTypeHasNoKeys validation rule.

Microsoft.OData.Edm

  • IEdmEntityType EntityType property introduced in IEdmNavigationSource interface.
    • Any implementation of IEdmNavigationSource needs to implement the EntityType property.
    • The public EntityType(IEdmNavigationSource) static method has been marked as obsolete and will be removed in ODL 9.
  • Last updated on