trait JsonSchemas extends algebra.JsonSchemas with TuplesSchemas
An interpreter for endpoints4s.algebra.JsonSchemas that produces a JSON schema for a given algebraic data type description.
The encoding of the schemas of sealed traits (obtained with the operation
orElse
or via generic derivation) can be configured by overriding
JsonSchemas.coproductEncoding.
- Self Type
- JsonSchemas
- Alphabetic
- By Inheritance
- JsonSchemas
- TuplesSchemas
- JsonSchemas
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- TuplesSchemas
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- sealed trait CoproductEncoding extends AnyRef
- sealed trait DocumentedJsonSchema extends AnyRef
- class Enum[A] extends JsonSchema[A]
-
implicit final
class
EnumOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
-
implicit
class
InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
- class JsonSchema[A] extends AnyRef
-
sealed
trait
JsonSchemaDocumentationOps[A] extends AnyRef
- Definition Classes
- JsonSchemas
-
implicit final
class
JsonSchemaOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
-
implicit
class
PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
- class Record[A] extends JsonSchema[A]
-
implicit final
class
RecordOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
- class Tagged[A] extends JsonSchema[A]
-
implicit final
class
TaggedOps[A] extends JsonSchemaDocumentationOps[A]
- Definition Classes
- JsonSchemas
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
arrayJsonSchema[C[X] <: Iterable[X], A](implicit jsonSchema: JsonSchema[A], factory: scala.collection.compat.Factory[A, C[A]]): JsonSchema[C[A]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
implicit
lazy val
bigdecimalJsonSchema: JsonSchema[BigDecimal]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
bigdecimalWithConstraintsJsonSchema(constraints: NumericConstraints[BigDecimal]): JsonSchema[BigDecimal]
- Definition Classes
- JsonSchemas → JsonSchemas
-
lazy val
booleanJsonSchema: JsonSchema[Boolean]
- Definition Classes
- JsonSchemas → JsonSchemas
-
lazy val
byteJsonSchema: JsonSchema[Byte]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
choiceTagged[A, B](taggedA: Tagged[A], taggedB: Tagged[B]): Tagged[Either[A, B]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
coproductEncoding: CoproductEncoding
Override this method to customize the strategy used to encode the JSON schema of coproducts.
Override this method to customize the strategy used to encode the JSON schema of coproducts. By default, it uses CoproductEncoding.OneOf.
- See also
-
def
defaultDiscriminatorName: String
- Definition Classes
- JsonSchemas
-
implicit final
def
defaultStringJsonSchema: JsonSchema[String]
- Definition Classes
- JsonSchemas
-
implicit
lazy val
doubleJsonSchema: JsonSchema[Double]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
doubleWithConstraintsJsonSchema(constraints: NumericConstraints[Double]): JsonSchema[Double]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
lazy val
durationSchema: JsonSchema[Duration]
- Definition Classes
- JsonSchemas
-
def
emptyRecord: Record[Unit]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
enumeration[A](values: Seq[A])(tpe: JsonSchema[A]): Enum[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
field[A](name: String, docs: Documentation)(implicit tpe: JsonSchema[A]): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
lazy val
floatJsonSchema: JsonSchema[Float]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
floatWithConstraintsJsonSchema(constraints: NumericConstraints[Float]): JsonSchema[Float]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
lazy val
instantJsonSchema: JsonSchema[Instant]
- Definition Classes
- JsonSchemas
-
implicit
lazy val
intJsonSchema: JsonSchema[Int]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
intWithConstraintsJsonSchema(constraints: NumericConstraints[Int]): JsonSchema[Int]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
implicit
def
jsonSchemaPartialInvFunctor: PartialInvariantFunctor[JsonSchema]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazyRecord[A](schema: ⇒ Record[A], name: String): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
lazyTagged[A](schema: ⇒ Tagged[A], name: String): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
literal[A](value: A)(implicit tpe: JsonSchema[A]): JsonSchema[Unit]
- Definition Classes
- JsonSchemas
-
implicit
lazy val
longJsonSchema: JsonSchema[Long]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
longWithConstraintsJsonSchema(constraints: NumericConstraints[Long]): JsonSchema[Long]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
mapJsonSchema[A](implicit jsonSchema: JsonSchema[A]): JsonSchema[Map[String, A]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
namedEnum[A](schema: Enum[A], name: String): Enum[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
namedRecord[A](schema: Record[A], name: String): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
namedTagged[A](schema: Tagged[A], name: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
lazy val
offsetDateTimeSchema: JsonSchema[OffsetDateTime]
- Definition Classes
- JsonSchemas
-
def
optField[A](name: String, docs: Documentation)(implicit tpe: JsonSchema[A]): Record[Option[A]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
optFieldWithDefault[A](name: String, defaultValue: A, docs: Option[String])(implicit arg0: JsonSchema[A]): Record[A]
- Definition Classes
- JsonSchemas
-
def
orElseMergeTagged[A, C >: A, B <: C](taggedA: Tagged[A], taggedB: Tagged[B])(implicit arg0: ClassTag[A], arg1: ClassTag[B]): Tagged[C]
- Definition Classes
- JsonSchemas
-
def
orFallbackToJsonSchema[A, B](schemaA: JsonSchema[A], schemaB: JsonSchema[B]): JsonSchema[Either[A, B]]
- Definition Classes
- JsonSchemas → JsonSchemas
-
implicit
def
recordPartialInvFunctor: PartialInvariantFunctor[Record]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
stringEnumeration[A](values: Seq[A])(encode: (A) ⇒ String)(implicit tpe: JsonSchema[String]): Enum[A]
- Definition Classes
- JsonSchemas
-
def
stringJsonSchema(format: Option[String]): JsonSchema[String]
- Definition Classes
- JsonSchemas → JsonSchemas
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
implicit
def
taggedPartialInvFunctor: PartialInvariantFunctor[Tagged]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
taggedRecord[A](recordA: Record[A], tag: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
toSchema(jsonSchema: DocumentedJsonSchema): Schema
Convert the internal representation of a JSON schema into the public OpenAPI AST
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit
def
tuple10JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple11JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple12JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple13JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple14JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple15JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple16JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple17JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple18JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple19JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple20JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple21JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple22JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9], schema10: JsonSchema[T10], schema11: JsonSchema[T11], schema12: JsonSchema[T12], schema13: JsonSchema[T13], schema14: JsonSchema[T14], schema15: JsonSchema[T15], schema16: JsonSchema[T16], schema17: JsonSchema[T17], schema18: JsonSchema[T18], schema19: JsonSchema[T19], schema20: JsonSchema[T20], schema21: JsonSchema[T21], schema22: JsonSchema[T22]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10, T11, T12, T13, T14, T15, T16, T17, T18, T19, T20, T21, T22)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple2JsonSchema[T1, T2](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2]): JsonSchema[(T1, T2)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple3JsonSchema[T1, T2, T3](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3]): JsonSchema[(T1, T2, T3)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple4JsonSchema[T1, T2, T3, T4](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4]): JsonSchema[(T1, T2, T3, T4)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple5JsonSchema[T1, T2, T3, T4, T5](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5]): JsonSchema[(T1, T2, T3, T4, T5)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple6JsonSchema[T1, T2, T3, T4, T5, T6](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6]): JsonSchema[(T1, T2, T3, T4, T5, T6)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple7JsonSchema[T1, T2, T3, T4, T5, T6, T7](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple8JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
implicit
def
tuple9JsonSchema[T1, T2, T3, T4, T5, T6, T7, T8, T9](implicit schema1: JsonSchema[T1], schema2: JsonSchema[T2], schema3: JsonSchema[T3], schema4: JsonSchema[T4], schema5: JsonSchema[T5], schema6: JsonSchema[T6], schema7: JsonSchema[T7], schema8: JsonSchema[T8], schema9: JsonSchema[T9]): JsonSchema[(T1, T2, T3, T4, T5, T6, T7, T8, T9)]
- Definition Classes
- TuplesSchemas → TuplesSchemas
-
final
lazy val
ujsonSchemas: ujson.JsonSchemas
The JSON codecs used to produce some parts of the documentation.
-
implicit final
lazy val
uuidJsonSchema: JsonSchema[UUID]
- Definition Classes
- JsonSchemas
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
def
withDescriptionEnum[A](enumeration: Enum[A], description: String): Enum[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withDescriptionJsonSchema[A](schema: JsonSchema[A], description: String): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withDescriptionRecord[A](record: Record[A], description: String): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withDescriptionTagged[A](tagged: Tagged[A], description: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withDiscriminatorTagged[A](tagged: Tagged[A], discriminatorName: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withExampleEnum[A](enumeration: Enum[A], example: A): Enum[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withExampleJsonSchema[A](schema: JsonSchema[A], example: A): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withExampleRecord[A](record: Record[A], example: A): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withExampleTagged[A](tagged: Tagged[A], example: A): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withTitleEnum[A](enumeration: Enum[A], title: String): Enum[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withTitleJsonSchema[A](schema: JsonSchema[A], title: String): JsonSchema[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withTitleRecord[A](record: Record[A], title: String): Record[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
withTitleTagged[A](tagged: Tagged[A], title: String): Tagged[A]
- Definition Classes
- JsonSchemas → JsonSchemas
-
def
zipRecords[A, B](recordA: Record[A], recordB: Record[B])(implicit t: Tupler[A, B]): Record[Out]
- Definition Classes
- JsonSchemas → JsonSchemas
-
object
CoproductEncoding
This object contains the options for how to encode coproduct JSON schemas.
This object contains the options for how to encode coproduct JSON schemas.
The following Scala coproduct is the candidate example. Each encoding option includes the schema that it would generate for that example.
sealed trait Pet case class Cat(name: String) extends Pet case class Lizard(lovesRocks: Boolean) extends Pet
- object DocumentedJsonSchema