circe-json-schema
API
Generated with
circe-json-schema/net.reactivecore.cjs

net.reactivecore.cjs

package net.reactivecore.cjs

Members list

Concise view

Type members

Classlikes

case class BooleanSchema(value: Boolean) extends Schema

A Schema which directly evaluates into true or false

A Schema which directly evaluates into true or false

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Schema
class Object
trait Matchable
class Any
object BooleanSchema

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract class DataTypeName(val name: String)

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object DtArray.type
object DtBoolean.type
object DtInteger.type
object DtNull.type
object DtNumber.type
object DtObject.type
object DtString.type
object DataTypeName

Attributes

Companion:
class
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Definitions(defs: Option[VectorMap[String, Schema]])

Describes sub definitions.

Describes sub definitions.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Definitions

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Description(title: Option[String], description: Option[String], default: Option[Json], $comment: Option[String])

Human description of a Schema

Human description of a Schema

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Description

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class DocumentValidator(mainId: RefUri, roots: Map[RefUri, SingleDocumentValidator])

Validator for a full resolved schema document.

Validator for a full resolved schema document.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object DocumentValidator

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Failure

Base trait for Errors

Base trait for Errors

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class JsonFailure(message: String, cause: Error) extends Failure

There was an JSON Error.

There was an JSON Error.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Failure
class Object
trait Matchable
class Any
object JsonFailure

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Loader[F[_]](downloader: Downloader[F], defaultVocabulary: Vocabulary)(implicit monad: MonadError[F, Failure])

Combines the different steps to build a SchemaValidator from JSON.

Combines the different steps to build a SchemaValidator from JSON.

Main entry point into handling JSON Schemas.

Attributes

defaultVocabulary

the default vocabulary to use if none is given

downloader

the downloader to download referenced schemas or meta schemas

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Loader

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
Loader.type
case class Location(schema: Option[String], id: Option[RefUri])

Describes location of a Schema.

Describes location of a Schema.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Location

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MetaSchema($vocabulary: Option[Map[String, Boolean]])

Contains (part of) information of the Meta Schema.

Contains (part of) information of the Meta Schema.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object MetaSchema

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ObjectSchema(location: Location, ref: Ref, description: Description, definitions: Definitions, restriction: Restriction) extends Schema

A Schema in Object form.

A Schema in Object form.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Schema
class Object
trait Matchable
class Any
object ObjectSchema

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Ref(ref: Option[RefUri], anchor: Option[String], dynamicRef: Option[RefUri], dynamicAnchor: Option[String], recursiveAnchor: Option[Boolean], recursiveRef: Option[RefUri])

Contains reference fields within a Schema.

Contains reference fields within a Schema.

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Ref

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Ref.type
case class ResolveFailure(message: String, cause: Option[Throwable]) extends Failure

There was an resolving error.

There was an resolving error.

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Failure
class Object
trait Matchable
class Any
sealed trait Schema

A JSON Schema

A JSON Schema

Attributes

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Schema

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Schema.type
case class SchemaOrigin(parentId: RefUri, path: JsonPointer)

Context which led to this schema

Context which led to this schema

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
case class SingleDocumentValidator(schema: Schema, validator: SchemaValidator)

Validator for a single document within DocumentValidator

Validator for a single document within DocumentValidator

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Vocabularies

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class Vocabulary(schemaId: String, parts: Seq[VocabularyPart])

Defines a vocabulary and builds a JSON Filter on top of it. For default vocabularies look into Vocabularies

Defines a vocabulary and builds a JSON Filter on top of it. For default vocabularies look into Vocabularies

Attributes

schemaId

id of the schema defining this vocabulary

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
object Vocabulary

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Types

type Result[T] = Either[Failure, T]
Generated with