JsonSchema

zio.blocks.schema.json.JsonSchema
See theJsonSchema companion trait
object JsonSchema

Attributes

Companion
trait
Source
JsonSchema.scala
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
JsonSchema.type

Members list

Type members

Classlikes

case object False extends JsonSchema

Schema that rejects all instances. Equivalent to {"not": {}}.

Schema that rejects all instances. Equivalent to {"not": {}}.

Attributes

Source
JsonSchema.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
False.type
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.

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
Supertypes
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Object

Attributes

Companion
class
Source
JsonSchema.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Object.type
case object True extends JsonSchema

Schema that accepts all instances. Equivalent to {}.

Schema that accepts all instances. Equivalent to {}.

Attributes

Source
JsonSchema.scala
Supertypes
trait Singleton
trait Product
trait Mirror
trait JsonSchema
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
True.type

Types

type Anchor = Anchor

Attributes

Source
JsonSchema.scala
type RegexPattern = RegexPattern

Attributes

Source
JsonSchema.scala
type UriReference = UriReference

Attributes

Source
JsonSchema.scala

Inherited and Abstract types

type MirroredElemLabels <: Tuple

The names of the product elements.

The names of the product elements.

Attributes

Inherited from:
Mirror
Source
Mirror.scala
type MirroredLabel <: String

The name of the type.

The name of the type.

Attributes

Inherited from:
Mirror
Source
Mirror.scala

Value members

Concrete methods

def array(items: Option[JsonSchema] = ..., prefixItems: Option[NonEmptyChunk[JsonSchema]] = ..., minItems: Option[NonNegativeInt] = ..., maxItems: Option[NonNegativeInt] = ..., uniqueItems: Option[Boolean] = ..., contains: Option[JsonSchema] = ..., minContains: Option[NonNegativeInt] = ..., maxContains: Option[NonNegativeInt] = ..., unevaluatedItems: Option[JsonSchema] = ...): JsonSchema

Attributes

Source
JsonSchema.scala
def array(items: JsonSchema, minItems: NonNegativeInt, maxItems: NonNegativeInt): JsonSchema

Convenience constructor for array schema with items and length constraints.

Convenience constructor for array schema with items and length constraints.

Attributes

Source
JsonSchema.scala
def array(items: JsonSchema): JsonSchema

Convenience constructor for array schema with just items.

Convenience constructor for array schema with just items.

Attributes

Source
JsonSchema.scala
def constOf(value: Json): JsonSchema

Attributes

Source
JsonSchema.scala
def enumOf(values: NonEmptyChunk[Json]): JsonSchema

Attributes

Source
JsonSchema.scala
def enumOfStrings(values: NonEmptyChunk[String]): JsonSchema

Attributes

Source
JsonSchema.scala
def fromJson(json: Json): Either[SchemaError, JsonSchema]

Parse a JsonSchema from its JSON representation.

Parse a JsonSchema from its JSON representation.

Attributes

Source
JsonSchema.scala
def integer(minimum: Option[BigDecimal] = ..., maximum: Option[BigDecimal] = ..., exclusiveMinimum: Option[BigDecimal] = ..., exclusiveMaximum: Option[BigDecimal] = ..., multipleOf: Option[PositiveNumber] = ...): JsonSchema

Attributes

Source
JsonSchema.scala
def number(minimum: Option[BigDecimal] = ..., maximum: Option[BigDecimal] = ..., exclusiveMinimum: Option[BigDecimal] = ..., exclusiveMaximum: Option[BigDecimal] = ..., multipleOf: Option[PositiveNumber] = ...): JsonSchema

Attributes

Source
JsonSchema.scala
def obj(properties: Option[ChunkMap[String, JsonSchema]] = ..., required: Option[Set[String]] = ..., additionalProperties: Option[JsonSchema] = ..., patternProperties: Option[ChunkMap[RegexPattern, JsonSchema]] = ..., propertyNames: Option[JsonSchema] = ..., minProperties: Option[NonNegativeInt] = ..., maxProperties: Option[NonNegativeInt] = ..., unevaluatedProperties: Option[JsonSchema] = ..., title: Option[String] = ..., allOf: Option[NonEmptyChunk[JsonSchema]] = ..., dependentSchemas: Option[ChunkMap[String, JsonSchema]] = ...): JsonSchema

Attributes

Source
JsonSchema.scala
def ofType(t: JsonSchemaType): JsonSchema

Attributes

Source
JsonSchema.scala
def parse(jsonString: String): Either[SchemaError, JsonSchema]

Parse a JsonSchema from a JSON string.

Parse a JsonSchema from a JSON string.

Attributes

Source
JsonSchema.scala
def ref(uri: UriReference): JsonSchema

Attributes

Source
JsonSchema.scala
def refString(uri: String): JsonSchema

Attributes

Source
JsonSchema.scala
def string(minLength: Option[NonNegativeInt] = ..., maxLength: Option[NonNegativeInt] = ..., pattern: Option[RegexPattern] = ..., format: Option[String] = ...): JsonSchema

Attributes

Source
JsonSchema.scala
def string(minLength: NonNegativeInt, maxLength: NonNegativeInt): JsonSchema

Convenience constructor for string schema with non-optional length constraints.

Convenience constructor for string schema with non-optional length constraints.

Attributes

Source
JsonSchema.scala
def string(pattern: RegexPattern): JsonSchema

Convenience constructor for string schema with pattern.

Convenience constructor for string schema with pattern.

Attributes

Source
JsonSchema.scala

Concrete fields

val Anchor: Anchor.type

Attributes

Source
JsonSchema.scala
val NonNegativeInt: NonNegativeInt.type

Attributes

Source
JsonSchema.scala
val PositiveNumber: PositiveNumber.type

Attributes

Source
JsonSchema.scala
val RegexPattern: RegexPattern.type

Attributes

Source
JsonSchema.scala
val UriReference: UriReference.type

Attributes

Source
JsonSchema.scala
val boolean: JsonSchema

Attributes

Source
JsonSchema.scala
val nullSchema: JsonSchema

Attributes

Source
JsonSchema.scala