Packages

case class Reference(name: String, original: Option[Schema], description: Option[String], example: None.type = None, title: None.type = None) extends Schema with Product with Serializable

Source
OpenApi.scala
Linear Supertypes
Serializable, Product, Equals, Schema, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Reference
  2. Serializable
  3. Product
  4. Equals
  5. Schema
  6. AnyRef
  7. Any
Implicitly
  1. by StringFormat
  2. by Ensuring
  3. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Reference(name: String, original: Option[Schema], description: Option[String], example: None.type = None, title: None.type = None)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def ->[B](y: B): (Reference, B)
    Implicit
    This member is added by an implicit conversion from Reference toArrowAssoc[Reference] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  7. val description: Option[String]
    Definition Classes
    ReferenceSchema
  8. def ensuring(cond: (Reference) => Boolean, msg: => Any): Reference
    Implicit
    This member is added by an implicit conversion from Reference toEnsuring[Reference] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Reference) => Boolean): Reference
    Implicit
    This member is added by an implicit conversion from Reference toEnsuring[Reference] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: => Any): Reference
    Implicit
    This member is added by an implicit conversion from Reference toEnsuring[Reference] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Reference
    Implicit
    This member is added by an implicit conversion from Reference toEnsuring[Reference] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. val example: None.type
    Definition Classes
    ReferenceSchema
  14. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Reference toStringFormat[Reference] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val name: String
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  22. val original: Option[Schema]
  23. def productElementNames: Iterator[String]
    Definition Classes
    Product
  24. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  25. val title: None.type
    Definition Classes
    ReferenceSchema
  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  29. def withDefinedDescription(description: Option[String]): Schema

    returns

    The same schema with its description overridden by the given description, or stay unchanged if this one is empty.

    Definition Classes
    Schema

Deprecated Value Members

  1. def [B](y: B): (Reference, B)
    Implicit
    This member is added by an implicit conversion from Reference toArrowAssoc[Reference] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Schema

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringFormat fromReference to StringFormat[Reference]

Inherited by implicit conversion Ensuring fromReference to Ensuring[Reference]

Inherited by implicit conversion ArrowAssoc fromReference to ArrowAssoc[Reference]

Ungrouped