Merge pull request #367 from microsoft/fix/required-cancellation-token

fix: optional parameters alignments for serialization methods

CHANGELOG.md

@@ -7,11 +7,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.12.3] - 2024-09-03
+
+### Changed
+
+- Fixed optional parameters in KiotaJsonSerialization. [#366](https://github.com/microsoft/kiota-dotnet/issues/366)
+
 ## [1.12.2] - 2024-08-23
 
 ### Changed
 
-- Fixed a bug where calls to ApiClientBuilder.EnableBackingStoreForParseNodeFactory and ApiClientBuilder.EnableBackingStoreForSerializationWriterFactory would enable a BackingStore around BackingStores. [#2563] (https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues/2563) [#2588] (https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues/2588)
+- Fixed a bug where calls to ApiClientBuilder.EnableBackingStoreForParseNodeFactory and ApiClientBuilder.EnableBackingStoreForSerializationWriterFactory would enable a BackingStore around BackingStores. [#2563] (<https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues/2563>) [#2588] (<https://github.com/microsoftgraph/msgraph-sdk-dotnet/issues/2588>)
 
 ## [1.12.1] - 2024-08-21
 

Directory.Build.props

@@ -1,7 +1,7 @@
 <Project>
   <!-- Common default project properties for ALL projects-->
   <PropertyGroup>
-    <VersionPrefix>1.12.2</VersionPrefix>
+    <VersionPrefix>1.12.3</VersionPrefix>
     <VersionSuffix></VersionSuffix>
     <!-- This is overidden in test projects by setting to true-->
     <IsTestProject>false</IsTestProject>

src/abstractions/RequestInformation.cs

@@ -5,12 +5,14 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.Diagnostics;
 using System.IO;
 using System.Reflection;
 using System.Runtime.Serialization;
 using Microsoft.Kiota.Abstractions.Extensions;
 using Microsoft.Kiota.Abstractions.Serialization;
+
 #if NET5_0_OR_GREATER
 using System.Diagnostics.CodeAnalysis;
 #endif
@@ -316,6 +318,7 @@ public void SetResponseHandler(IResponseHandler responseHandler)
         /// </summary>
         /// <param name="content">The binary stream to set as a body.</param>
         [Obsolete("Use SetStreamContent and pass the content type instead")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public void SetStreamContent(Stream content) => SetStreamContent(content, BinaryContentType);
 
         /// <summary>

src/abstractions/serialization/IParseNodeFactory.cs

@@ -3,6 +3,7 @@
 // ------------------------------------------------------------------------------
 
 using System;
+using System.ComponentModel;
 using System.IO;
 
 namespace Microsoft.Kiota.Abstractions.Serialization
@@ -23,6 +24,7 @@ public interface IParseNodeFactory
         /// <param name="contentType">The content type of the parse node.</param>
         /// <returns>A parse node.</returns>
         [Obsolete("Use GetRootParseNodeAsync instead")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         IParseNode GetRootParseNode(string contentType, Stream content);
     }
 }

src/abstractions/serialization/KiotaJsonSerializer.Deserialization.cs

@@ -4,9 +4,11 @@
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
+
 #if NET5_0_OR_GREATER
 using System.Diagnostics.CodeAnalysis;
 #endif
@@ -25,6 +27,7 @@ public static partial class KiotaJsonSerializer
     /// <param name="parsableFactory">The factory to create the object.</param>
     /// <param name="serializedRepresentation">The serialized representation of the object.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static T? Deserialize<T>(string serializedRepresentation, ParsableFactory<T> parsableFactory) where T : IParsable
         => KiotaSerializer.Deserialize(_jsonContentType, serializedRepresentation, parsableFactory);
     /// <summary>
@@ -33,13 +36,15 @@ public static partial class KiotaJsonSerializer
     /// <param name="stream">The stream to deserialize.</param>
     /// <param name="parsableFactory">The factory to create the object.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static T? Deserialize<T>(Stream stream, ParsableFactory<T> parsableFactory) where T : IParsable
     => KiotaSerializer.Deserialize(_jsonContentType, stream, parsableFactory);
     /// <summary>
     /// Deserializes the given stream into an object.
     /// </summary>
     /// <param name="stream">The stream to deserialize.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static T? Deserialize<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(Stream stream) where T : IParsable
 #else
@@ -51,6 +56,7 @@ public static partial class KiotaJsonSerializer
     /// </summary>
     /// <param name="serializedRepresentation">The serialized representation of the object.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static T? Deserialize<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(string serializedRepresentation) where T : IParsable
 #else
@@ -63,6 +69,7 @@ public static partial class KiotaJsonSerializer
     /// <param name="stream">The stream to deserialize.</param>
     /// <param name="parsableFactory">The factory to create the object.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static IEnumerable<T> DeserializeCollection<T>(Stream stream, ParsableFactory<T> parsableFactory) where T : IParsable
     => KiotaSerializer.DeserializeCollection(_jsonContentType, stream, parsableFactory);
     /// <summary>
@@ -71,13 +78,15 @@ public static IEnumerable<T> DeserializeCollection<T>(Stream stream, ParsableFac
     /// <param name="serializedRepresentation">The serialized representation of the objects.</param>
     /// <param name="parsableFactory">The factory to create the object.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static IEnumerable<T> DeserializeCollection<T>(string serializedRepresentation, ParsableFactory<T> parsableFactory) where T : IParsable
     => KiotaSerializer.DeserializeCollection(_jsonContentType, serializedRepresentation, parsableFactory);
     /// <summary>
     /// Deserializes the given stream into a collection of objects based on the content type.
     /// </summary>
     /// <param name="stream">The stream to deserialize.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static IEnumerable<T> DeserializeCollection<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(Stream stream) where T : IParsable
 #else
@@ -89,6 +98,7 @@ public static IEnumerable<T> DeserializeCollection<T>(Stream stream) where T : I
     /// </summary>
     /// <param name="serializedRepresentation">The serialized representation of the object.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static IEnumerable<T> DeserializeCollection<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(string serializedRepresentation) where T : IParsable
 #else

src/abstractions/serialization/KiotaJsonSerializer.Serialization.cs

@@ -22,9 +22,10 @@ public static partial class KiotaJsonSerializer
     /// </summary>
     /// <typeparam name="T">Type of the object to serialize</typeparam>
     /// <param name="value">The object to serialize.</param>
+    /// <param name="serializeOnlyChangedValues">By default, you'll only get the changed properties.</param>
     /// <returns>The serialized representation as a stream.</returns>
-    public static Stream SerializeAsStream<T>(T value) where T : IParsable
-        => KiotaSerializer.SerializeAsStream(_jsonContentType, value);
+    public static Stream SerializeAsStream<T>(T value, bool serializeOnlyChangedValues = true) where T : IParsable
+        => KiotaSerializer.SerializeAsStream(_jsonContentType, value, serializeOnlyChangedValues);
 
     /// <summary>
     /// Serializes the given object into a string based on the content type.
@@ -44,17 +45,31 @@ public static string SerializeAsString<T>(T value) where T : IParsable
     /// <param name="value">The object to serialize.</param>
     /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
     /// <returns>The serialized representation as a string.</returns>
+    [Obsolete("This method is obsolete, use SerializeAsStringAsync with optional CancellationToken parameter instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static Task<string> SerializeAsStringAsync<T>(T value, CancellationToken cancellationToken) where T : IParsable
-        => KiotaSerializer.SerializeAsStringAsync(_jsonContentType, value, true, cancellationToken);
+        => SerializeAsStringAsync(value, true, cancellationToken);
+
+    /// <summary>
+    /// Serializes the given object into a string based on the content type.
+    /// </summary>
+    /// <typeparam name="T">Type of the object to serialize</typeparam>
+    /// <param name="value">The object to serialize.</param>
+    /// <param name="serializeOnlyChangedValues">By default, you'll only get the changed properties.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The serialized representation as a string.</returns>
+    public static Task<string> SerializeAsStringAsync<T>(T value, bool serializeOnlyChangedValues = true, CancellationToken cancellationToken = default) where T : IParsable
+        => KiotaSerializer.SerializeAsStringAsync(_jsonContentType, value, serializeOnlyChangedValues, cancellationToken);
 
     /// <summary>
     /// Serializes the given object into a string based on the content type.
     /// </summary>
     /// <typeparam name="T">Type of the object to serialize</typeparam>
     /// <param name="value">The object to serialize.</param>
+    /// <param name="serializeOnlyChangedValues">By default, you'll only get the changed properties.</param>
     /// <returns>The serialized representation as a stream.</returns>
-    public static Stream SerializeAsStream<T>(IEnumerable<T> value) where T : IParsable
-    => KiotaSerializer.SerializeAsStream(_jsonContentType, value);
+    public static Stream SerializeAsStream<T>(IEnumerable<T> value, bool serializeOnlyChangedValues = true) where T : IParsable
+    => KiotaSerializer.SerializeAsStream(_jsonContentType, value, serializeOnlyChangedValues);
 
     /// <summary>
     /// Serializes the given object into a string based on the content type.
@@ -73,6 +88,19 @@ public static string SerializeAsString<T>(IEnumerable<T> value) where T : IParsa
     /// <param name="value">The object to serialize.</param>
     /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
     /// <returns>The serialized representation as a string.</returns>
+    [Obsolete("This method is obsolete, use SerializeAsStringAsync with optional CancellationToken parameter instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static Task<string> SerializeAsStringAsync<T>(IEnumerable<T> value, CancellationToken cancellationToken) where T : IParsable =>
-        KiotaSerializer.SerializeAsStringAsync(_jsonContentType, value, true, cancellationToken);
+        SerializeAsStringAsync(value, true, cancellationToken);
+
+    /// <summary>
+    /// Serializes the given object into a string based on the content type.
+    /// </summary>
+    /// <typeparam name="T">Type of the object to serialize</typeparam>
+    /// <param name="value">The object to serialize.</param>
+    /// <param name="serializeOnlyChangedValues">By default, you'll only get the changed properties.</param>
+    /// <param name="cancellationToken">The token to monitor for cancellation requests.</param>
+    /// <returns>The serialized representation as a string.</returns>
+    public static Task<string> SerializeAsStringAsync<T>(IEnumerable<T> value, bool serializeOnlyChangedValues = true, CancellationToken cancellationToken = default) where T : IParsable =>
+        KiotaSerializer.SerializeAsStringAsync(_jsonContentType, value, serializeOnlyChangedValues, cancellationToken);
 }

src/abstractions/serialization/KiotaSerializer.Deserialization.cs

@@ -4,10 +4,12 @@
 
 using System;
 using System.Collections.Generic;
+using System.ComponentModel;
 using System.IO;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
+
 #if NET5_0_OR_GREATER
 using System.Diagnostics.CodeAnalysis;
 #endif
@@ -24,6 +26,7 @@ public static partial class KiotaSerializer
     /// <param name="parsableFactory">The factory to create the object.</param>
     /// <param name="serializedRepresentation">The serialized representation of the object.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static T? Deserialize<T>(string contentType, string serializedRepresentation, ParsableFactory<T> parsableFactory) where T : IParsable
     {
         if(string.IsNullOrEmpty(serializedRepresentation)) throw new ArgumentNullException(nameof(serializedRepresentation));
@@ -49,6 +52,7 @@ private static Stream GetStreamFromString(string source)
     /// <param name="stream">The stream to deserialize.</param>
     /// <param name="parsableFactory">The factory to create the object.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static T? Deserialize<T>(string contentType, Stream stream, ParsableFactory<T> parsableFactory) where T : IParsable
     {
         if(string.IsNullOrEmpty(contentType)) throw new ArgumentNullException(nameof(contentType));
@@ -63,6 +67,7 @@ private static Stream GetStreamFromString(string source)
     /// <param name="contentType">The content type of the stream.</param>
     /// <param name="stream">The stream to deserialize.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static T? Deserialize<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(string contentType, Stream stream) where T : IParsable
 #else
@@ -86,6 +91,7 @@ private static ParsableFactory<T> GetFactoryFromType<T>() where T : IParsable
     /// <param name="contentType">The content type of the stream.</param>
     /// <param name="serializedRepresentation">The serialized representation of the object.</param>
     [Obsolete("Use DeserializeAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static T? Deserialize<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(string contentType, string serializedRepresentation) where T : IParsable
 #else
@@ -100,6 +106,7 @@ private static ParsableFactory<T> GetFactoryFromType<T>() where T : IParsable
     /// <param name="stream">The stream to deserialize.</param>
     /// <param name="parsableFactory">The factory to create the object.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static IEnumerable<T> DeserializeCollection<T>(string contentType, Stream stream, ParsableFactory<T> parsableFactory) where T : IParsable
     {
         if(string.IsNullOrEmpty(contentType)) throw new ArgumentNullException(nameof(contentType));
@@ -115,6 +122,7 @@ public static IEnumerable<T> DeserializeCollection<T>(string contentType, Stream
     /// <param name="serializedRepresentation">The serialized representation of the objects.</param>
     /// <param name="parsableFactory">The factory to create the object.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static IEnumerable<T> DeserializeCollection<T>(string contentType, string serializedRepresentation, ParsableFactory<T> parsableFactory) where T : IParsable
     {
         if(string.IsNullOrEmpty(serializedRepresentation)) throw new ArgumentNullException(nameof(serializedRepresentation));
@@ -127,6 +135,7 @@ public static IEnumerable<T> DeserializeCollection<T>(string contentType, string
     /// <param name="contentType">The content type of the stream.</param>
     /// <param name="stream">The stream to deserialize.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static IEnumerable<T> DeserializeCollection<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(string contentType, Stream stream) where T : IParsable
 #else
@@ -139,6 +148,7 @@ public static IEnumerable<T> DeserializeCollection<T>(string contentType, Stream
     /// <param name="contentType">The content type of the stream.</param>
     /// <param name="serializedRepresentation">The serialized representation of the object.</param>
     [Obsolete("Use DeserializeCollectionAsync instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
 #if NET5_0_OR_GREATER
     public static IEnumerable<T> DeserializeCollection<[DynamicallyAccessedMembers(DynamicallyAccessedMemberTypes.PublicMethods)] T>(string contentType, string serializedRepresentation) where T : IParsable
 #else

src/abstractions/serialization/KiotaSerializer.Serialization.cs

@@ -45,6 +45,7 @@ public static Stream SerializeAsStream<T>(string contentType, T value, bool seri
     /// <param name="value">The object to serialize.</param>
     /// <returns>The serialized representation as a string.</returns>
     [Obsolete("This method is obsolete, use the async method instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static string SerializeAsString<T>(string contentType, T value) where T : IParsable
     {
         using var stream = SerializeAsStream(contentType, value);
@@ -97,6 +98,7 @@ public static Stream SerializeAsStream<T>(string contentType, IEnumerable<T> val
     /// <param name="value">The object to serialize.</param>
     /// <returns>The serialized representation as a string.</returns>
     [Obsolete("This method is obsolete, use the async method instead")]
+    [EditorBrowsable(EditorBrowsableState.Never)]
     public static string SerializeAsString<T>(string contentType, IEnumerable<T> value) where T : IParsable
     {
         using var stream = SerializeAsStream(contentType, value);

src/abstractions/serialization/ParseNodeFactoryRegistry.cs

@@ -4,6 +4,7 @@
 
 using System;
 using System.Collections.Concurrent;
+using System.ComponentModel;
 using System.IO;
 using System.Text.RegularExpressions;
 using System.Threading;
@@ -43,6 +44,7 @@ public string ValidContentType
         /// <param name="content">The <see cref="Stream"/> to parse</param>
         /// <returns></returns>
         [Obsolete("Use GetRootParseNodeAsync instead")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public IParseNode GetRootParseNode(string contentType, Stream content)
         {
             if(string.IsNullOrEmpty(contentType))

src/abstractions/serialization/ParseNodeProxyFactory.cs

@@ -3,6 +3,7 @@
 // ------------------------------------------------------------------------------
 
 using System;
+using System.ComponentModel;
 using System.IO;
 using System.Threading;
 using System.Threading.Tasks;
@@ -40,6 +41,7 @@ protected ParseNodeProxyFactory(IParseNodeFactory concrete, Action<IParsable> on
         /// <param name="contentType">The content type of the parse node.</param>
         /// <returns>A parse node.</returns>
         [Obsolete("Use GetRootParseNodeAsync instead")]
+        [EditorBrowsable(EditorBrowsableState.Never)]
         public IParseNode GetRootParseNode(string contentType, Stream content)
         {
             var node = _concrete.GetRootParseNode(contentType, content);