dotnet/runtime

Support using any dictionary as JsonExtensionData

Open

#31,645 opened on Feb 3, 2020

View on GitHub
 (23 comments) (8 reactions) (1 assignee)C# (5,445 forks)batch import
area-System.Text.Jsonenhancementhelp wantedwishlist

Repository metrics

Stars
 (17,886 stars)
PR merge metrics
 (Avg merge 12d 11h) (661 merged PRs in 30d)

Description

IMHO, IReadOnlyDictionary should work identical to IDictionary when using with JsonExtensionData attribute.

[JsonExtensionData]
public IReadOnlyDictionary<string, JsonElement> Payload { get; set; }

Currently it fails with error:

System.InvalidOperationException: The data extension property 'Payload' does not match the required signature of IDictionary<string, JsonElement> or IDictionary<string, object>.

This is analogous to collection properties which can be defined as List<T>, IList<T> or IReadOnlyList<T> etc.

Contributor guide

Research direction
Examine the System.Text.Json source code for JsonExtensionData handling. Understand how IDictionary<string, JsonElement> is currently supported and identify the changes needed to also support IReadOnlyDictionary<string, JsonElement>. Look for the validation logic that checks the property type and extend it accordingly.
Tech stack
csharp
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
C#.NETJSON serialization
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65