Object

zio.blocks.schema.json.JsonSchema.Object
See theObject companion object
final case class Object($id: Option[UriReference] = ..., $schema: Option[URI] = ..., $anchor: Option[Anchor] = ..., $dynamicAnchor: Option[Anchor] = ..., $ref: Option[UriReference] = ..., $dynamicRef: Option[UriReference] = ..., $vocabulary: Option[ChunkMap[URI, Boolean]] = ..., $defs: Option[ChunkMap[String, JsonSchema]] = ..., $comment: Option[String] = ..., allOf: Option[NonEmptyChunk[JsonSchema]] = ..., anyOf: Option[NonEmptyChunk[JsonSchema]] = ..., oneOf: Option[NonEmptyChunk[JsonSchema]] = ..., not: Option[JsonSchema] = ..., `if`: Option[JsonSchema] = ..., `then`: Option[JsonSchema] = ..., `else`: Option[JsonSchema] = ..., properties: Option[ChunkMap[String, JsonSchema]] = ..., patternProperties: Option[ChunkMap[RegexPattern, JsonSchema]] = ..., additionalProperties: Option[JsonSchema] = ..., propertyNames: Option[JsonSchema] = ..., dependentSchemas: Option[ChunkMap[String, JsonSchema]] = ..., prefixItems: Option[NonEmptyChunk[JsonSchema]] = ..., items: Option[JsonSchema] = ..., contains: Option[JsonSchema] = ..., unevaluatedProperties: Option[JsonSchema] = ..., unevaluatedItems: Option[JsonSchema] = ..., `type`: Option[SchemaType] = ..., enum: Option[NonEmptyChunk[Json]] = ..., const: Option[Json] = ..., multipleOf: Option[PositiveNumber] = ..., maximum: Option[BigDecimal] = ..., exclusiveMaximum: Option[BigDecimal] = ..., minimum: Option[BigDecimal] = ..., exclusiveMinimum: Option[BigDecimal] = ..., minLength: Option[NonNegativeInt] = ..., maxLength: Option[NonNegativeInt] = ..., pattern: Option[RegexPattern] = ..., minItems: Option[NonNegativeInt] = ..., maxItems: Option[NonNegativeInt] = ..., uniqueItems: Option[Boolean] = ..., minContains: Option[NonNegativeInt] = ..., maxContains: Option[NonNegativeInt] = ..., minProperties: Option[NonNegativeInt] = ..., maxProperties: Option[NonNegativeInt] = ..., required: Option[Set[String]] = ..., dependentRequired: Option[ChunkMap[String, Set[String]]] = ..., format: Option[String] = ..., contentEncoding: Option[String] = ..., contentMediaType: Option[String] = ..., contentSchema: Option[JsonSchema] = ..., title: Option[String] = ..., description: Option[String] = ..., default: Option[Json] = ..., deprecated: Option[Boolean] = ..., readOnly: Option[Boolean] = ..., writeOnly: Option[Boolean] = ..., examples: Option[NonEmptyChunk[Json]] = ..., extensions: ChunkMap[String, Json] = ...) extends JsonSchema

A schema object containing keywords from JSON Schema 2020-12. All fields are optional; an empty Object is equivalent to True.

Attributes

Companion
object
Source
JsonSchema.scala
Graph
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

override def check(json: Json): Option[SchemaError]

Validate a JSON value against this schema.

Validate a JSON value against this schema.

Attributes

Returns

None if valid, Some(error) with accumulated failures if invalid.

Definition Classes
Source
JsonSchema.scala
override def check(json: Json, options: ValidationOptions): Option[SchemaError]

Validate a JSON value against this schema with custom options.

Validate a JSON value against this schema with custom options.

Value parameters

json

The JSON value to validate

options

Validation options controlling behavior like format validation

Attributes

Returns

None if valid, Some(error) with accumulated failures if invalid.

Definition Classes
Source
JsonSchema.scala

Inherited methods

def &&(that: JsonSchema): JsonSchema

Combine with another schema using allOf.

Combine with another schema using allOf.

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def conforms(json: Json, options: ValidationOptions): Boolean

Returns true if the JSON value conforms to this schema with custom options.

Returns true if the JSON value conforms to this schema with custom options.

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def conforms(json: Json): Boolean

Returns true if the JSON value conforms to this schema.

Returns true if the JSON value conforms to this schema.

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def productElementNames: Iterator[String]

An iterator over the names of all the elements of this product.

An iterator over the names of all the elements of this product.

Attributes

Inherited from:
Product
Source
Product.scala
def productIterator: Iterator[Any]

An iterator over all the elements of this product.

An iterator over all the elements of this product.

Attributes

Returns

in the default implementation, an Iterator[Any]

Inherited from:
Product
Source
Product.scala
override def toString: String

Returns a string representation of the object.

Returns a string representation of the object.

The default representation is platform dependent.

Attributes

Returns

a string representation of the object.

Definition Classes
JsonSchema -> Any
Inherited from:
JsonSchema
Source
JsonSchema.scala
def unary_!: JsonSchema

Negate this schema.

Negate this schema.

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def withDiscriminatorField(name: String, value: String): JsonSchema

Add a required property for the provided discriminator field.

Add a required property for the provided discriminator field.

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def withNullable: JsonSchema

Make this schema nullable (accepts null in addition to current types).

Make this schema nullable (accepts null in addition to current types).

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala
def ||(that: JsonSchema): JsonSchema

Combine with another schema using anyOf.

Combine with another schema using anyOf.

Attributes

Inherited from:
JsonSchema
Source
JsonSchema.scala

Concrete fields

lazy override val toJson: Json

Serialize this schema to its canonical JSON representation.

Serialize this schema to its canonical JSON representation.

Attributes

Source
JsonSchema.scala