using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization.Formatters;
using System.ComponentModel.DataAnnotations;
using System.Globalization;
using System.ComponentModel;
using Newtonsoft.Json.Linq;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Serialization;
using Newtonsoft.Json.Schema;
using Newtonsoft.Json.Schema.Generation;
[System.AttributeUsage(AttributeTargets.Property | AttributeTargets.Field, AllowMultiple = false)]
public class HiddenAttribute : System.Attribute
public class HiddenOptionProvider : CustomizedProviderBase
public override JSchema GetSchema(JSchemaTypeGenerationContext context)
var schema = base.GetSchema(context);
var contract = (JsonObjectContract)context.Generator.ContractResolver.ResolveContract(context.ObjectType);
foreach (var propertySchema in schema.Properties)
var jProperty = contract.Properties[propertySchema.Key];
if (jProperty.AttributeProvider.GetAttributes(typeof(HiddenAttribute), true).Any())
propertySchema.Value.ExtensionData["options"] = new JObject(new JProperty("hidden", true));
public override bool CanGenerateSchema(JSchemaTypeGenerationContext context) =>
base.CanGenerateSchema(context) && context.Generator.ContractResolver.ResolveContract(context.ObjectType) is JsonObjectContract;
public abstract class CustomizedProviderBase : JSchemaGenerationProvider
readonly Stack<Type> currentTypes = new ();
public override JSchema GetSchema(JSchemaTypeGenerationContext context)
if (CanGenerateSchema(context))
var currentType = context.ObjectType;
currentTypes.Push(currentType);
return context.Generator.Generate(currentType);
throw new NotImplementedException();
public override bool CanGenerateSchema(JSchemaTypeGenerationContext context) =>
!currentTypes.TryPeek(out var t) || t != context.ObjectType;
[JsonProperty("name", Required = Required.DisallowNull)]
[DefaultValue("Jeremy Dorn"), MinLength(4), System.ComponentModel.DescriptionAttribute("First and Last name")]
public string Name { get; set; } = "Jeremy Dorn";
[DisplayName("SpecialPerson")]
public class SpecialPerson
[JsonProperty("name", Required = Required.DisallowNull)]
[DefaultValue("Jeremy Dorn"), MinLength(4), System.ComponentModel.DescriptionAttribute("First and Last name")]
public string Name { get; set; } = "Jeremy Dorn";
[JsonProperty(Required = Required.DisallowNull)]
public string Title { get; set; }
[JsonProperty(Required = Required.DisallowNull)]
public List<SpecialPerson> MorePeople { get; set; } = new ();
public static void Test()
Test<Person>(JSchema.Parse(GetQuestionSchema()));
Test<decimal>(JSchema.Parse(@"{""type"":""number""}"));
TestExample(new { SpecialPerson = default(SpecialPerson) });
public static void TestExample<Person>(Person example, JSchema requiredSchema = null)
Test<Person>(requiredSchema);
public static void Test<Person>(JSchema requiredSchema = null)
Console.WriteLine("\nGenerating schema for {0}:", typeof(Person));
var generator = new JSchemaGenerator();
generator.GenerationProviders.Add(new HiddenOptionProvider());
var schema = generator.Generate(typeof(Person));
Console.WriteLine(schema);
if (requiredSchema != null)
Assert.IsTrue(JToken.DeepEquals(JToken.FromObject(schema), JToken.FromObject(requiredSchema)));
static string GetQuestionSchema() => @"{
""options"": { ""hidden"": true },
""description"": ""First and Last name"",
""default"": ""Jeremy Dorn""
public static void Main()
Console.WriteLine("Environment version: {0} ({1})", System.Runtime.InteropServices.RuntimeInformation.FrameworkDescription , GetNetCoreVersion());
Console.WriteLine("Json.NET version: " + typeof(JsonSerializer).Assembly.FullName);
Console.WriteLine("Json.NET Schema version: " + typeof(Newtonsoft.Json.Schema.JSchema).Assembly.FullName);
Console.WriteLine("Failed with unhandled exception: ");
public static string GetNetCoreVersion()
var assembly = typeof(System.Runtime.GCSettings).GetTypeInfo().Assembly;
var assemblyPath = assembly.Location.Split(new[] { '/', '\\' }, StringSplitOptions.RemoveEmptyEntries);
int netCoreAppIndex = Array.IndexOf(assemblyPath, "Microsoft.NETCore.App");
if (netCoreAppIndex > 0 && netCoreAppIndex < assemblyPath.Length - 2)
return assemblyPath[netCoreAppIndex + 1];