Packages

object DocumentedJsonSchema

Source
JsonSchemas.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DocumentedJsonSchema
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class Array(schema: Either[DocumentedJsonSchema, List[DocumentedJsonSchema]], description: Option[String] = None, example: Option[Value] = None, title: Option[String] = None) extends DocumentedJsonSchema with Product with Serializable

    schema

    Left(itemSchema) for a homogeneous array, or Right(itemSchemas) for a heterogeneous array (ie, a tuple)

  2. case class DocumentedCoProd(alternatives: List[(String, DocumentedRecord)], name: Option[String] = None, discriminatorName: String = defaultDiscriminatorName, description: Option[String] = None, example: Option[Value] = None, title: Option[String] = None) extends DocumentedJsonSchema with Product with Serializable
  3. case class DocumentedEnum(elementType: DocumentedJsonSchema, values: List[Value], name: Option[String], description: Option[String] = None, example: Option[Value] = None, title: Option[String] = None) extends DocumentedJsonSchema with Product with Serializable
  4. case class DocumentedRecord(fields: List[Field], additionalProperties: Option[DocumentedJsonSchema] = None, name: Option[String] = None, description: Option[String] = None, example: Option[Value] = None, title: Option[String] = None) extends DocumentedJsonSchema with Product with Serializable
  5. case class Field(name: String, tpe: DocumentedJsonSchema, isOptional: Boolean, documentation: Option[String]) extends Product with Serializable
  6. sealed abstract class LazySchema extends DocumentedJsonSchema
  7. case class OneOf(alternatives: List[DocumentedJsonSchema], description: Option[String] = None, example: Option[Value] = None, title: Option[String] = None) extends DocumentedJsonSchema with Product with Serializable
  8. case class Primitive(name: String, format: Option[String] = None, description: Option[String] = None, example: Option[Value] = None, title: Option[String] = None) extends DocumentedJsonSchema with Product with Serializable

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  20. object LazySchema

Inherited from AnyRef

Inherited from Any

Ungrouped