How to write a JsonSchemaBuilder for a class that has a property of a class? about json-everything HOT 4 CLOSED

I would expect what you have to work just fine. Have you tried it?

The validating deserialization works (in this example) by creating a serializer when you deserialize ParentClass. That serializer will decode the entire payload and validate it against ParentClass.Schema which has the reference to PropertyClass.Schema already.

So all validation really occurs at the parent level. You need the entire schema there.

If validation is successful, the validating serializer will be removed from the options (so that the serializing one doesn't get called again), and then it will attempt to deserialize with the updated options.

from json-everything.

I haven't tried it because it is still missing a piece of validation. I want the property of PropertyClass to also be required and I see no way to do that. I also have the string properties set as Required. Validation is missing in ParentClass.Schema.

from json-everything.

I think I figured it out. I am passing the Properties from the PropertyClass.Schema into the JsonSchemaBuilder of ParentClass. That seems to be doing the validation for me. I did realize that I was doing Required wrong. Since it was an optional parameter for the name, I thought if you just put Required() on the JsonSchemaBuilder that it would assign required to property name.

If there is a better way to do Required, much appreciated to know.

Here is my new code:

using Json.Schema;
using Json.Schema.Serialization;
using System.ComponentModel.DataAnnotations;

namespace JsonInvestigation;

[JsonSchema(typeof(ParentClass), nameof(Schema))]   
public sealed class ParentClass
{
    [Required]
    [StringLength(5)]
    public string Name { get; set; } = string.Empty;

    [Required]
    public PropertyClass Property { get; set; } = new PropertyClass();

    public readonly static JsonSchema Schema = new JsonSchemaBuilder()
        .Type(SchemaValueType.Object)
        .Properties((nameof(Name), new JsonSchemaBuilder()
            .Type(SchemaValueType.String)
            .MaxLength(5)),
            (nameof(Property), new JsonSchemaBuilder()
                .Type(SchemaValueType.Object)
                .Properties(PropertyClass.Schema.GetProperties() ?? new Dictionary<string, JsonSchema>())))
        .Required(nameof(Name), nameof(Property));
}

[JsonSchema(typeof(PropertyClass), nameof(Schema))]
public sealed class PropertyClass
{
    [Required]
    [StringLength(5)]
    public string Name { get; set; } = string.Empty;

    public readonly static JsonSchema Schema = new JsonSchemaBuilder()
        .Type(SchemaValueType.Object)
        .Properties((nameof(Name), new JsonSchemaBuilder()
            .Type(SchemaValueType.String)
            .MaxLength(5)))
        .Required(nameof(Name));

}

from json-everything.

The builder extensions mimic the schema itself. The required keyword is placed at the object level to require the properties which are required in that object.

{
  "type": "object",
  "required": ["foo"]
}

The extension method acts the same.

JsonSchema schema = new JsonSchemaBuilder()
     .Type(SchemaValueType.Object)
     .Required("foo");

from json-everything.