core

Type Members

1. final case class PartialSchemaKey(vendor: String, name: String, format: String, version: SchemaVer) extends Product with Serializable

   

   Entity describing schema of data, which **can** be unknown, by known or unknown SchemaVer.

   Entity describing schema of data, which **can** be unknown, by known or unknown SchemaVer. Extracted from schema key.

2. trait Resolver[F[_], A] extends AnyRef

   

   Entity allowing to fetch and validate schemas for entities of A Resolvers supposed to be implemented as separate artifacts

   Entity allowing to fetch and validate schemas for entities of A Resolvers supposed to be implemented as separate artifacts

   F

   effect, wrapping resolver's work (such as Either[String, Option[A]] or IO[A]

   A

   AST for data and schema

3. final case class SchemaCriterion(vendor: String, name: String, format: String, model: Option[Int] = None, revision: Option[Int] = None, addition: Option[Int] = None) extends Product with Serializable

   

   Class to filter Schemas by SchemaKey

4. final case class SchemaKey(vendor: String, name: String, format: String, version: Full) extends Product with Serializable

   

   Entity describing schema of data, Duality of SchemaMap Unlike PartialSchemaKey it always has full known version

5. final case class SchemaMap(vendor: String, name: String, format: String, version: Full) extends Product with Serializable

   

   Entity describing a schema object itself Has known SchemaVer, extracted from self Schema's subobject Duality of SchemaKey

6. sealed trait SchemaVer extends AnyRef

   

   Class holding semantic version for Schema

   Class holding semantic version for Schema

   + model Schema MODEL, representing independent Schema + revision Schema REVISION, representing backward-incompatible changes + addition Schema ADDITION, representing backward-compatible changes

7. final case class SelfDescribingData[D](schema: SchemaKey, data: D) extends Product with Serializable

   

   Container for Self-describing data Used to eliminate need of Option container when extracting SchemaKey with ExtractSchemaKey type class

   Container for Self-describing data Used to eliminate need of Option container when extracting SchemaKey with ExtractSchemaKey type class

   D

   generic type to represent data instance type (usually it is some JSON-library's base trait)

   schema

   attached data instance itself

   data

   reference to Schema

8. final case class SelfDescribingSchema[S](self: SchemaMap, schema: S) extends Product with Serializable

   

   Container for Self-describing Schema Used to eliminate need of Option container when extracting SchemaMap with ExtractSchemaMap type class

   Container for Self-describing Schema Used to eliminate need of Option container when extracting SchemaMap with ExtractSchemaMap type class

   S

   generic type to represent Schema type (usually it is some JSON-library's base trait)

   self

   Schema description

   schema

   attached Schema instance itself

9. trait syntax extends AnyRef