[JsonSchemaExporter]: Respecting data annotations + schema version
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 38/100
Research direction
Start at JsonSerializerOptions and the GetJsonSchemaAsNode entry point described in the issue, then trace the JsonSchemaExporter implementation. Review how data annotations and schema metadata are currently handled. Done means the requested annotation support and selectable draft version are defined and covered by the relevant exporter behavior.
Written by the indexing model from the issue text.
Description
Background and motivation
When trying to migrate from Newtonsoft.Json.Schema to pure JsonSchemaExporter (without any third party libraries) I have noticed that at least two features are missing.
- Respecting data annotations (for example including in schema min and max of given type)
- Possibility to select schema draft version
Would you guys consider adding them so the transition would be possible without taking dependency on external libraries?
Newtonsoft.Json.Schema:
{
"$schema" : "http://json-schema.org/draft-07/schema#",
"definitions" : {
"Nested<UInt16>" : {
"type" : "object",
"properties" : {
"required" : {
"type" : "integer",
"minimum" : 0.0,
"maximum" : 65535.0
},
"nullable" : {
"type" : [ "integer", "null" ],
"minimum" : 0.0,
"maximum" : 65535.0
}
},
"required" : [ "required" ]
}
},
"type" : "object",
"properties" : {
"required" : {
"type" : "integer",
"minimum" : 0.0,
"maximum" : 65535.0
},
"nullable" : {
"type" : [ "integer", "null" ],
"minimum" : 0.0,
"maximum" : 65535.0
},
"nested" : {
"$ref" : "#/definitions/Nested<UInt16>"
}
},
"required" : [ "required", "nested" ]
}
STJ:
{
"type" : [ "object", "null" ],
"properties" : {
"required" : {
"type" : "integer"
},
"nullable" : {
"type" : [ "integer", "null" ]
},
"nested" : {
"type" : "object",
"properties" : {
"required" : {
"type" : "integer"
},
"nullable" : {
"type" : [ "integer", "null" ]
}
},
"required" : [ "required", "nullable" ]
}
},
"required" : [ "required", "nullable", "nested" ]
}
API Proposal
JsonSerializerOptions options = new(JsonSerializerOptions.Default)
{
RespectDataAnnotations= true,
Version = "draft-07"
};
API Usage
JsonSerializerOptions options = new(JsonSerializerOptions.Default)
{
PropertyNamingPolicy = JsonNamingPolicy.KebabCaseUpper,
NumberHandling = JsonNumberHandling.WriteAsString,
UnmappedMemberHandling = JsonUnmappedMemberHandling.Disallow,
RespectDataAnnotations= true,
Version = "draft-07"
};
JsonNode schema = options.GetJsonSchemaAsNode(typeof(MyPoco));
Console.WriteLine(schema.ToString());
Alternative Designs
No response
Risks
No response
- Dominant language
- C#
- Stars
- 18.3k
- Forks
- 5.6k
- PR merge metrics
- PR metrics pending
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from dotnet/runtime
-
agentic-workflows untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
area-System.Reflection blocking-clean-ci-optional Known Build Error os-mac-os-x untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
area-CodeGen-coreclr untriaged
Difficulty 1/5 Under an hour Newbie friendliness 92/100
-
agentic-workflows untriaged
Difficulty 1/5 Under an hour Newbie friendliness 78/100
-
area-VM-meta-mono untriaged
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
-
:watch: Not Triaged 11.0 fundamentals/subsvc
Difficulty 2/5 1-3 hours Newbie friendliness 92/100
dotnet/AspNetCore.Docs#37699 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
SubtitleEdit/subtitleedit#15108 · 1 comment ·
-
area/docs-content Bug pulumi/docs
Difficulty 1/5 1-3 hours Newbie friendliness 94/100
-
Create parent directories only after the containment check in InstallHelper.TryExtractToDirectory Open
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
PowerShell/PSResourceGet#2056 ·