Skip to content

Commit 75cf885

Browse files
committed
Review updates
1 parent 09e9435 commit 75cf885

File tree

3 files changed

+169
-30
lines changed

3 files changed

+169
-30
lines changed

Diff for: src/EFCore.Cosmos/Storage/Internal/CosmosTypeMappingSource.cs

+19-1
Original file line numberDiff line numberDiff line change
@@ -168,18 +168,36 @@ private static ValueComparer CreateStringDictionaryComparer(
168168

169169
// This ensures that the element reader/writers are not null when using Cosmos dictionary type mappings, but
170170
// is never actually used because Cosmos does not (yet) read and write JSON using this mechanism.
171+
/// <summary>
172+
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
173+
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
174+
/// any release. You should only use it directly in your code with extreme caution and knowing that
175+
/// doing so can result in application failures when updating to a new Entity Framework Core release.
176+
/// </summary>
171177
#pragma warning disable EF1001
172-
private sealed class PlaceholderJsonStringKeyedDictionaryReaderWriter<TElement>(JsonValueReaderWriter elementReaderWriter)
178+
public sealed class PlaceholderJsonStringKeyedDictionaryReaderWriter<TElement>(JsonValueReaderWriter elementReaderWriter)
173179
: JsonValueReaderWriter<IEnumerable<KeyValuePair<string, TElement>>>, ICompositeJsonValueReaderWriter
174180
#pragma warning restore EF1001
175181
{
176182
private readonly JsonValueReaderWriter<TElement> _elementReaderWriter = (JsonValueReaderWriter<TElement>)elementReaderWriter;
177183

184+
/// <summary>
185+
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
186+
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
187+
/// any release. You should only use it directly in your code with extreme caution and knowing that
188+
/// doing so can result in application failures when updating to a new Entity Framework Core release.
189+
/// </summary>
178190
public override IEnumerable<KeyValuePair<string, TElement>> FromJsonTyped(
179191
ref Utf8JsonReaderManager manager,
180192
object? existingObject = null)
181193
=> throw new NotImplementedException("JsonValueReaderWriter infrastructure is not supported on Cosmos.");
182194

195+
/// <summary>
196+
/// This is an internal API that supports the Entity Framework Core infrastructure and not subject to
197+
/// the same compatibility standards as public APIs. It may be changed or removed without notice in
198+
/// any release. You should only use it directly in your code with extreme caution and knowing that
199+
/// doing so can result in application failures when updating to a new Entity Framework Core release.
200+
/// </summary>
183201
public override void ToJsonTyped(Utf8JsonWriter writer, IEnumerable<KeyValuePair<string, TElement>> value)
184202
=> throw new NotImplementedException("JsonValueReaderWriter infrastructure is not supported on Cosmos.");
185203

0 commit comments

Comments
 (0)