endpoints.documented.openapi

JsonSchemas

trait JsonSchemas extends algebra.JsonSchemas

An interpreter for algebra.JsonSchemas that produces a JSON schema for a given algebraic data type description.

Source
JsonSchemas.scala
Linear Supertypes
algebra.JsonSchemas, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. JsonSchemas
  2. JsonSchemas
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. sealed trait DocumentedJsonSchema extends AnyRef

  2. type JsonSchema[+A] = DocumentedJsonSchema

    The JSON schema of a type A

    The JSON schema of a type A

    Definition Classes
    JsonSchemas → JsonSchemas

  3. implicit final class JsonSchemaOps[A] extends AnyRef

    Convenient infix operations

  4. type Record[+A] = DocumentedRecord

    The JSON schema of a record type (case class) A

    The JSON schema of a record type (case class) A

    Definition Classes
    JsonSchemas → JsonSchemas

  5. implicit final class RecordOps[A] extends AnyRef

    Convenient infix operations

  6. type Tagged[+A] = DocumentedCoProd

    A JSON schema containing the name of the type A.

    A JSON schema containing the name of the type A. Tagged schemas are useful to describe sum types (sealed traits).

    Definition Classes
    JsonSchemas → JsonSchemas

  7. implicit final class TaggedOps[A] extends AnyRef

    Definition Classes
    JsonSchemas

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  6. object DocumentedJsonSchema

  7. def arrayJsonSchema[C[X] <: Seq[X], A](implicit jsonSchema: JsonSchema[A], cbf: CanBuildFrom[_, A, C[A]]): JsonSchema[C[A]]

    A JSON schema for sequences

    A JSON schema for sequences

    Definition Classes
    JsonSchemas → JsonSchemas

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. lazy val bigdecimalJsonSchema: DocumentedJsonSchema

    Definition Classes
    JsonSchemas → JsonSchemas

  10. lazy val booleanJsonSchema: DocumentedJsonSchema

    Definition Classes
    JsonSchemas → JsonSchemas

  11. def choiceTagged[A, B](taggedA: DocumentedCoProd, taggedB: DocumentedCoProd): DocumentedCoProd

    The JSON schema of a coproduct made of the given alternative tagged records

    The JSON schema of a coproduct made of the given alternative tagged records

    Definition Classes
    JsonSchemas → JsonSchemas

  12. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  13. lazy val doubleJsonSchema: DocumentedJsonSchema

    Definition Classes
    JsonSchemas → JsonSchemas

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def field[A](name: String, documentation: Option[String] = None)(implicit tpe: DocumentedJsonSchema): DocumentedRecord

    The JSON schema of a record with a single field name of type A

    The JSON schema of a record with a single field name of type A

    Definition Classes
    JsonSchemas → JsonSchemas

  17. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. lazy val intJsonSchema: DocumentedJsonSchema

    Definition Classes
    JsonSchemas → JsonSchemas

  21. def invmapJsonSchema[A, B](jsonSchema: DocumentedJsonSchema, f: (A) ⇒ B, g: (B) ⇒ A): DocumentedJsonSchema

    Transforms the type of the JSON schema

    Transforms the type of the JSON schema

    Definition Classes
    JsonSchemas → JsonSchemas

  22. def invmapRecord[A, B](record: DocumentedRecord, f: (A) ⇒ B, g: (B) ⇒ A): DocumentedRecord

    Transforms the type of the JSON schema

    Transforms the type of the JSON schema

    Definition Classes
    JsonSchemas → JsonSchemas

  23. def invmapTagged[A, B](tagged: DocumentedCoProd, f: (A) ⇒ B, g: (B) ⇒ A): DocumentedCoProd

    Transforms the type of the JSON schema

    Transforms the type of the JSON schema

    Definition Classes
    JsonSchemas → JsonSchemas

  24. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  25. lazy val longJsonSchema: DocumentedJsonSchema

    Definition Classes
    JsonSchemas → JsonSchemas

  26. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  27. final def notify(): Unit

    Definition Classes
    AnyRef

  28. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  29. def optField[A](name: String, documentation: Option[String] = None)(implicit tpe: DocumentedJsonSchema): DocumentedRecord

    The JSON schema of a record with a single optional field name of type A

    The JSON schema of a record with a single optional field name of type A

    Definition Classes
    JsonSchemas → JsonSchemas

  30. lazy val stringJsonSchema: DocumentedJsonSchema

    Definition Classes
    JsonSchemas → JsonSchemas

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  32. def taggedRecord[A](recordA: DocumentedRecord, tag: String): DocumentedCoProd

    Tags a schema for type A with the given tag name

    Tags a schema for type A with the given tag name

    Definition Classes
    JsonSchemas → JsonSchemas

  33. def toString(): String

    Definition Classes
    AnyRef → Any

  34. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. def zipRecords[A, B](recordA: DocumentedRecord, recordB: DocumentedRecord): DocumentedRecord

    The JSON schema of a record merging the fields of the two given records

    The JSON schema of a record merging the fields of the two given records

    Definition Classes
    JsonSchemas → JsonSchemas

Inherited from algebra.JsonSchemas

Inherited from AnyRef

Inherited from Any

Ungrouped