Packages

o

sttp.tapir.Schema

annotations

object annotations

Annotations which are used during automatic schema derivation, or semi-automatic schema derivation using Schema.derived.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. annotations
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class customise extends Annotation with StaticAnnotation with Serializable
  2. class default[T] extends Annotation with StaticAnnotation with Serializable
  3. class deprecated extends Annotation with StaticAnnotation with Serializable
  4. class description extends Annotation with StaticAnnotation with Serializable
  5. class encodedExample extends Annotation with StaticAnnotation with Serializable
  6. class encodedName extends Annotation with StaticAnnotation with Serializable
  7. class format extends Annotation with StaticAnnotation with Serializable
  8. class hidden extends Annotation with StaticAnnotation with Serializable
  9. class validate[T] extends Annotation with StaticAnnotation with Serializable

    Adds the v validator to the schema using Schema.validate.

    Adds the v validator to the schema using Schema.validate. Note that the type of the validator must match exactly the type of the class/field. This is not checked at compile-time, and might cause run-time exceptions. To validate elements of collections or Options, use validateEach.

  10. class validateEach[T] extends Annotation with StaticAnnotation with Serializable

    Adds the v validators to elements of the schema, when the annotated class or field is a collection or Option.

    Adds the v validators to elements of the schema, when the annotated class or field is a collection or Option. The type of the validator must match exactly the type of the collection's elements. This is not checked at compile-time, and might cause run-time exceptions. E.g. to validate that when an Option[Int] is defined, the value is smaller than 5, you should use:

    case class Payload(
      @validateEach(Validator.max(4, exclusive = true))
      aField: Option[Int]
    )

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() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped