class JSONSchema::FluentObjectValidator

• JSONSchema::FluentObjectValidator
• Reference
• Object

Overview

A fluent API for creating instances of JSONSchema::ObjectValidator.

Included Modules

• JSONSchema::FluentValidatorGenericProperties

Defined in:

Instance Method Summary

• #additional_properties(v : Validator)

  Set the validator for any additional properties not in the properties definition.

• #dependent_required(name : String, values : Array(String))

  Set a single dependent required property by name.

• #dependent_required(value : Hash(String, Array(String)))

  Set the list of dependent required properties.

• #dependent_schema(name : String, &)

  Set a single dependent schema property by name.

• #disable_additional_properties

  Set the constraint for disabling additional properties.

• #max_properties(value : Int32)

  Set a validator for the minimum number of properties that must be on the object.

• #min_properties(value : Int32)

  Set a validator for the minimum number of properties that must be on the object.

• #pattern_prop(pattern : Regex, v : Validator)

  Set the validator for a given Regex.

• #prop(name : String, v : Validator)

  Set the validator for a property by name.

• #property_names(v : Validator)

  Set a validator for all property names.

• #required(*properties)

  Set the list of required properties as any number of strings.

• #validator : JSONSchema::ObjectValidator

Instance Method Detail

validator = JSONSchema.fluent.object do
  dependent_required "creditCard", ["billingAddress"]
  dependent_required "couponCode", ["source"]
end

validator = JSONSchema.fluent.object do
  dependent_required({
    "creditCard" => ["billingAddress"],
  })
end

# Validates that "prop1" is both present and a number, given "prop1" is present
validator = JSONSchema.fluent.object do
  dependent_schema "prop1" do
    prop "prop2", JSONSchema.fluent.number
    required "prop2"
  end
end

validator = JSONSchema.fluent.object do
  required "name", "age"
end