Packages

o

sttp.tapir.EndpointIO

annotations

object annotations

Annotations which are used by EndpointInput.derived and EndpointOutput.derived to specify how a case class maps to an endpoint input/output.

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. All

Type Members

  1. sealed trait EndpointInputAnnotation extends Annotation with StaticAnnotation
  2. sealed trait EndpointOutputAnnotation extends Annotation with StaticAnnotation
  3. class apikey extends Annotation with StaticAnnotation
  4. class basic extends Annotation with StaticAnnotation
  5. class bearer extends Annotation with StaticAnnotation
  6. class body[R, CF <: CodecFormat] extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
  7. class byteArrayBody extends body[Array[Byte], OctetStream]
  8. class byteBufferBody extends body[ByteBuffer, OctetStream]
  9. class cookie extends Annotation with EndpointInputAnnotation
  10. class cookies extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
  11. class customise extends Annotation with StaticAnnotation
  12. class description extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation

    Specifies the description of the endpoint input/output.

    Specifies the description of the endpoint input/output. Note that this is distinct from Schema.annotations.description, which sets the description on the schema associated with the input/output.

  13. class endpointInput extends Annotation with EndpointInputAnnotation

    A class-level annotation, specifies the path to the endpoint.

    A class-level annotation, specifies the path to the endpoint. To capture segments of the path, surround the segment's name with {...} (curly braces), and reference the name using annotations.path.

  14. class example extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation

    Specifies the example value of the endpoint input/output.

    Specifies the example value of the endpoint input/output. Note that this is distinct from Schema.annotations.encodedExample, which sets the example on the schema associated with the input/output.

  15. class fileBody extends body[FileRange, OctetStream]
  16. class formBody extends body[String, XWwwFormUrlencoded]
  17. class header extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
  18. class headers extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
  19. class inputStreamBody extends body[InputStream, OctetStream]
  20. class jsonbody extends body[String, Json]
  21. class multipartBody extends body[Seq[RawPart], MultipartFormData]
  22. class params extends Annotation with EndpointInputAnnotation
  23. class path extends Annotation with EndpointInputAnnotation
  24. class query extends Annotation with EndpointInputAnnotation
  25. class securitySchemeName extends Annotation with StaticAnnotation
  26. class setCookie extends Annotation with EndpointOutputAnnotation
  27. class setCookies extends Annotation with EndpointOutputAnnotation
  28. class statusCode extends Annotation with EndpointOutputAnnotation
  29. class xmlbody extends body[String, Xml]

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( ... ) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    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( ... )
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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