object annotations
Annotations which are used by EndpointInput.derived and EndpointOutput.derived to specify how a case class maps to an endpoint input/output.
- Alphabetic
- By Inheritance
- annotations
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- sealed trait EndpointInputAnnotation extends Annotation with StaticAnnotation
- sealed trait EndpointOutputAnnotation extends Annotation with StaticAnnotation
- class apikey extends Annotation with StaticAnnotation
- class basic extends Annotation with StaticAnnotation
- class bearer extends Annotation with StaticAnnotation
- class body[R, CF <: CodecFormat] extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
- class byteArrayBody extends body[Array[Byte], OctetStream]
- class byteBufferBody extends body[ByteBuffer, OctetStream]
- class cookie extends Annotation with EndpointInputAnnotation
- class cookies extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
- class customise extends Annotation with StaticAnnotation
-
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.
-
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. -
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.
- class fileBody extends body[FileRange, OctetStream]
- class formBody extends body[String, XWwwFormUrlencoded]
- class header extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
- class headers extends Annotation with EndpointInputAnnotation with EndpointOutputAnnotation
- class inputStreamBody extends body[InputStream, OctetStream]
- class jsonbody extends body[String, Json]
- class multipartBody extends body[Seq[RawPart], MultipartFormData]
- class params extends Annotation with EndpointInputAnnotation
- class path extends Annotation with EndpointInputAnnotation
- class query extends Annotation with EndpointInputAnnotation
- class securitySchemeName extends Annotation with StaticAnnotation
- class setCookie extends Annotation with EndpointOutputAnnotation
- class setCookies extends Annotation with EndpointOutputAnnotation
- class statusCode extends Annotation with EndpointOutputAnnotation
- class xmlbody extends body[String, Xml]
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated