c

sttp.tapir.generic.internal

EndpointInputAnnotations

class EndpointInputAnnotations extends EndpointAnnotations

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. EndpointInputAnnotations
  2. EndpointAnnotations
  3. Tapir
  4. ModifyMacroSupport
  5. ModifyMacroFunctorSupport
  6. TapirDerivedInputs
  7. TapirExtensions
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new EndpointInputAnnotations(c: Context)

Type Members

  1. final class WebSocketBodyBuilder[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat] extends AnyRef
    Definition Classes
    Tapir
  2. type StringCodec[T] = Codec[String, T, TextPlain]
  3. type StringListCodec[T] = Codec[List[String], T, TextPlain]
    Definition Classes
    EndpointAnnotations
  4. type StringOptionCodec[T] = Codec[Option[String], T, TextPlain]
  5. type TapirFile = File
    Definition Classes
    TapirExtensions
  6. implicit class ModifyEach[F[_], T] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  7. trait ModifyFunctor[F[_], A] extends AnyRef
    Definition Classes
    ModifyMacroFunctorSupport
  8. implicit class ModifyEachMap[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport
  9. trait ModifyMapAtFunctor[F[_, _], K, T] extends AnyRef
    Definition Classes
    ModifyMacroSupport

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. def anyFromStringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF], charset: Charset): Body[String, T]

    A body in any format, read using the given codec, from a raw string read using charset.

    A body in any format, read using the given codec, from a raw string read using charset.

    Definition Classes
    Tapir
  5. def anyFromUtf8StringBody[T, CF <: CodecFormat](codec: Codec[String, T, CF]): Body[String, T]

    A body in any format, read using the given codec, from a raw string read using UTF-8.

    A body in any format, read using the given codec, from a raw string read using UTF-8.

    Definition Classes
    Tapir
  6. def anyJsonBody[T](implicit arg0: JsonCodec[T]): Body[String, T]

    Json codecs are usually derived from json-library-specific implicits.

    Json codecs are usually derived from json-library-specific implicits. That's why integrations with various json libraries define jsonBody methods, which directly require the library-specific implicits.

    If you have a custom json codec, you should use this method instead.

    Definition Classes
    Tapir
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def assignSchemaAnnotations[A](input: scala.reflect.macros.Universe.Tree, field: scala.reflect.macros.Universe.Symbol, util: CaseClassUtil[c.type, A]): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  9. def auth: TapirAuth.type
    Definition Classes
    Tapir
  10. def authChallenge(annotation: scala.reflect.macros.Universe.Annotation): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  11. def binaryBody[R, T](implicit arg0: Binary[R], arg1: Codec[R, T, OctetStream]): Body[R, T]
    Definition Classes
    Tapir
  12. def byteArrayBody: Body[Array[Byte], Array[Byte]]
    Definition Classes
    Tapir
  13. def byteBufferBody: Body[ByteBuffer, ByteBuffer]
    Definition Classes
    Tapir
  14. val c: Context
    Definition Classes
    EndpointInputAnnotations → EndpointAnnotations
  15. def clientIp: EndpointInput[Option[String]]
    Definition Classes
    TapirDerivedInputs
  16. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  17. def cookie[T](name: String)(implicit arg0: Codec[Option[String], T, TextPlain]): Cookie[T]
    Definition Classes
    Tapir
  18. def cookies: Header[List[Cookie]]
    Definition Classes
    Tapir
  19. val cookiesType: scala.reflect.macros.blackbox.Context.Type
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  20. def deriveEndpointInput[A](implicit arg0: scala.reflect.macros.blackbox.Context.WeakTypeTag[A]): scala.reflect.macros.blackbox.Context.Expr[EndpointInput[A]]
  21. val emptyOutput: EndpointOutput[Unit]

    An empty output.

    An empty output. Useful if one of oneOf branches should be mapped to the status code only.

    Definition Classes
    Tapir
  22. val endpoint: Endpoint[Unit, Unit, Unit, Any]
    Definition Classes
    Tapir
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  25. def extractFromRequest[T](f: (ServerRequest) ⇒ T): ExtractFromRequest[T]

    Extract a value from a server request.

    Extract a value from a server request. This input is only used by server interpreters, it is ignored by documentation interpreters and the provided value is discarded by client interpreters.

    Definition Classes
    Tapir
  26. def fileBody: Body[TapirFile, TapirFile]
    Definition Classes
    Tapir
  27. def formBody[T](charset: Charset)(implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  28. def formBody[T](implicit arg0: Codec[String, T, XWwwFormUrlencoded]): Body[String, T]
    Definition Classes
    Tapir
  29. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. def hasBodyAnnotation(field: scala.reflect.macros.blackbox.Context.Symbol): Option[scala.reflect.macros.Universe.Annotation]
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  31. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  32. def header(name: String, value: String): FixedHeader[Unit]
    Definition Classes
    Tapir
  33. def header(h: Header): FixedHeader[Unit]
    Definition Classes
    Tapir
  34. def header[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Header[T]
    Definition Classes
    Tapir
  35. val headerType: scala.reflect.macros.blackbox.Context.Type
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  36. def headers: Headers[List[Header]]
    Definition Classes
    Tapir
  37. val headersType: scala.reflect.macros.blackbox.Context.Type
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  38. val htmlBodyUtf8: Body[String, String]
    Definition Classes
    Tapir
  39. val infallibleEndpoint: Endpoint[Unit, Nothing, Unit, Any]
    Definition Classes
    Tapir
  40. def info(any: Any): Unit
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  41. def inputStreamBody: Body[InputStream, InputStream]
    Definition Classes
    Tapir
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def isWebSocket: EndpointInput[Boolean]
    Definition Classes
    TapirDerivedInputs
  44. def makeBodyIO(field: scala.reflect.macros.blackbox.Context.Symbol)(ann: scala.reflect.macros.Universe.Annotation): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  45. def makeCookiesIO(field: scala.reflect.macros.blackbox.Context.Symbol): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  46. def makeHeaderIO(field: scala.reflect.macros.blackbox.Context.Symbol)(altName: Option[String]): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  47. def makeHeadersIO(field: scala.reflect.macros.blackbox.Context.Symbol): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  48. implicit def mapModifyFunctor[M[KT, TT] <: Map[KT, TT], K, T](implicit cbf: CanBuildFrom[M[K, T], (K, T), M[K, T]]): ModifyMapAtFunctor[M, K, T]
    Definition Classes
    ModifyMacroSupport
  49. def mapToTargetFunc[A](fieldIdxToInputIdx: Map[Int, Int], util: CaseClassUtil[c.type, A]): scala.reflect.macros.Universe.Function
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  50. def multipartBody[T](implicit multipartCodec: MultipartCodec[T]): Body[Seq[RawPart], T]
    Definition Classes
    Tapir
  51. val multipartBody: Body[Seq[RawPart], Seq[Part[Array[Byte]]]]
    Definition Classes
    Tapir
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. def oneOf[T](firstCase: StatusMapping[_ <: T], otherCases: StatusMapping[_ <: T]*): OneOf[T, T]

    Maps status codes to outputs.

    Maps status codes to outputs. All outputs must have a common supertype (T). Typically, the supertype is a sealed trait, and the mappings are implementing cases classes.

    Note that exhaustiveness of the mappings is not checked (that all subtypes of T are covered).

    Definition Classes
    Tapir
  56. implicit def optionModifyFunctor[A]: ModifyFunctor[Option, A]
    Definition Classes
    ModifyMacroFunctorSupport
  57. def path[T](name: String)(implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  58. def path[T](implicit arg0: Codec[String, T, TextPlain]): PathCapture[T]
    Definition Classes
    Tapir
  59. def pathBody: Body[File, Path]
    Definition Classes
    TapirExtensions
  60. def paths: PathsCapture[List[String]]
    Definition Classes
    Tapir
  61. def plainBody[T](charset: Charset)(implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  62. def plainBody[T](implicit arg0: Codec[String, T, TextPlain]): Body[String, T]
    Definition Classes
    Tapir
  63. def query[T](name: String)(implicit arg0: Codec[List[String], T, TextPlain]): Query[T]
    Definition Classes
    Tapir
  64. def queryParams: QueryParams[QueryParams]
    Definition Classes
    Tapir
  65. def rawBinaryBody[R](implicit arg0: Binary[R], codec: Codec[R, R, OctetStream]): Body[R, R]
    Definition Classes
    Tapir
  66. val securitySchemeNameType: scala.reflect.macros.blackbox.Context.Type
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  67. def setCookie(name: String): Header[CookieValueWithMeta]
    Definition Classes
    Tapir
  68. def setCookies: Header[List[CookieWithMeta]]
    Definition Classes
    Tapir
  69. def setSecuritySchemeName[A](auth: scala.reflect.macros.Universe.Tree, schemeName: Option[scala.reflect.macros.Universe.Annotation]): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  70. def statusCode(statusCode: StatusCode): FixedStatusCode[Unit]
    Definition Classes
    Tapir
  71. def statusCode: StatusCode[StatusCode]
    Definition Classes
    Tapir
  72. def statusDefaultMapping[T](output: EndpointOutput[T]): StatusMapping[T]

    Create a fallback mapping to be used in oneOf output descriptions.

    Create a fallback mapping to be used in oneOf output descriptions.

    Definition Classes
    Tapir
  73. macro def statusMapping[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: ClassTag[T]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the runtime class of T.

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the runtime class of T.

    This will fail at compile-time if the type erasure of T is different from T, as a runtime check in this situation would give invalid results. In such cases, use statusMappingClassMatcher, statusMappingValueMatcher or statusMappingFromMatchType instead.

    Should be used in oneOf output descriptions.

    Definition Classes
    Tapir
  74. def statusMappingClassMatcher[T](statusCode: StatusCode, output: EndpointOutput[T], runtimeClass: Class[_]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the given runtimeClass.

    Create a status mapping which uses statusCode and output if the class of the provided value (when interpreting as a server) matches the given runtimeClass. Note that this does not take into account type erasure.

    Should be used in oneOf output descriptions.

    Definition Classes
    Tapir
  75. def statusMappingExactMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(firstExactValue: T, rest: T*)(implicit arg0: ClassTag[T]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the provided value exactly matches one of the values provided in the second argument list.

    Create a status mapping which uses statusCode and output if the provided value exactly matches one of the values provided in the second argument list.

    Should be used in oneOf output descriptions.

    Definition Classes
    Tapir
  76. def statusMappingFromMatchType[T](statusCode: StatusCode, output: EndpointOutput[T])(implicit arg0: MatchType[T]): StatusMapping[T]

    Experimental!

    Experimental!

    Create a status mapping which uses statusCode and output if the provided value matches the target type, as checked by MatchType. Instances of MatchType are automatically derived and recursively check that classes of all fields match, to bypass issues caused by type erasure.

    Should be used in oneOf output descriptions.

    Definition Classes
    Tapir
  77. def statusMappingValueMatcher[T](statusCode: StatusCode, output: EndpointOutput[T])(matcher: PartialFunction[Any, Boolean]): StatusMapping[T]

    Create a status mapping which uses statusCode and output if the provided value (when interpreting as a server matches the matcher predicate.

    Create a status mapping which uses statusCode and output if the provided value (when interpreting as a server matches the matcher predicate.

    Should be used in oneOf output descriptions.

    Definition Classes
    Tapir
  78. def streamBody[S](s: Streams[S])(schema: Schema[BinaryStream], format: CodecFormat, charset: Option[Charset] = None): StreamBodyIO[BinaryStream, BinaryStream, S]

    s

    A supported streams implementation.

    schema

    Schema of the body. This should be a schema for the "deserialized" stream.

    charset

    An optional charset of the resulting stream's data, to be used in the content type.

    Definition Classes
    Tapir
  79. def stringBody(charset: Charset): Body[String, String]
    Definition Classes
    Tapir
  80. def stringBody(charset: String): Body[String, String]
    Definition Classes
    Tapir
  81. def stringBody: Body[String, String]
    Definition Classes
    Tapir
  82. val stringConstructor: scala.reflect.macros.Universe.Type
  83. val stringListConstructor: scala.reflect.macros.Universe.Type
    Definition Classes
    EndpointAnnotations
  84. val stringOptionConstructor: scala.reflect.macros.Universe.Type
  85. implicit def stringToPath(s: String): FixedPath[Unit]
    Definition Classes
    Tapir
  86. def summonCodec(field: scala.reflect.macros.blackbox.Context.Symbol, tpe: scala.reflect.macros.Universe.Type): scala.reflect.macros.Universe.Tree
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  87. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  88. def toString(): String
    Definition Classes
    AnyRef → Any
  89. implicit def traversableModifyFunctor[F[_], A](implicit cbf: CanBuildFrom[F[A], A, F[A]], ev: (F[A]) ⇒ TraversableLike[A, F[A]]): ModifyFunctor[F, A]
    Definition Classes
    ModifyMacroSupport
  90. def validateCaseClass[A](util: CaseClassUtil[c.type, A]): Unit
    Attributes
    protected
    Definition Classes
    EndpointAnnotations
  91. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  92. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  93. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  94. def webSocketBody[REQ, REQ_CF <: CodecFormat, RESP, RESP_CF <: CodecFormat]: WebSocketBodyBuilder[REQ, REQ_CF, RESP, RESP_CF]

    REQ

    The type of messages that are sent to the server.

    REQ_CF

    The codec format (media type) of messages that are sent to the server.

    RESP

    The type of messages that are received from the server.

    RESP_CF

    The codec format (media type) of messages that are received from the server.

    Definition Classes
    Tapir
  95. def webSocketBodyRaw[S](s: Streams[S]): WebSocketBodyOutput[Pipe[WebSocketFrame, WebSocketFrame], WebSocketFrame, WebSocketFrame, Pipe[WebSocketFrame, WebSocketFrame], S]
    Definition Classes
    Tapir
  96. def xmlBody[T](implicit arg0: XmlCodec[T]): Body[String, T]

    Implement your own xml codec using Codec.xml() before using this method.

    Implement your own xml codec using Codec.xml() before using this method.

    Definition Classes
    Tapir

Deprecated Value Members

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

Inherited from EndpointAnnotations

Inherited from Tapir

Inherited from ModifyMacroSupport

Inherited from ModifyMacroFunctorSupport

Inherited from TapirDerivedInputs

Inherited from TapirExtensions

Inherited from AnyRef

Inherited from Any

Ungrouped