[JsonSchemaExporter]: Respecting data annotations + schema version

Open
#117,043 8 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp, json
Domain
api

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

api-suggestion area-System.Text.Json enhancement
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.

  1. Respecting data annotations (for example including in schema min and max of given type)
  2. 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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/runtime

All issues in dotnet/runtime

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.