io.github.daviddenton.fintrospect

Description

case class Description extends Product with Serializable

Encapsulates the description of a route.

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Description
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. val body: Option[Body]

  8. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val consumes: List[MimeType]

  10. def consuming(mimeType: MimeType*): Description

    Register mime types which the route will consume.

    Register mime types which the route will consume. This is informational only and is NOT currently enforced.

  11. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  12. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  13. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  14. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  15. val name: String

  16. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. final def notify(): Unit

    Definition Classes
    AnyRef
  18. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  19. val params: List[RequestParameter[_]]

  20. val produces: List[MimeType]

  21. def producing(mimeType: MimeType*): Description

    Register mime types which thus route will produce.

    Register mime types which thus route will produce. This is informational only and not currently enforced.

  22. val responses: List[ResponseWithExample]

  23. def returning(code: (HttpResponseStatus, String), example: JsonNode): Description

    Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).

  24. def returning(responseBuilder: ResponseBuilder): Description

    Register an exact possible response which could be produced by this route.

    Register an exact possible response which could be produced by this route. Will be used for schema generation if content is JSON.

  25. def returning(codes: (HttpResponseStatus, String)*): Description

    Register one or more possible responses which could be produced by this route.

  26. def returning(newResponse: ResponseWithExample): Description

    Register a possible response which could be produced by this route, with an example JSON body (used for schema generation).

  27. val summary: Option[String]

  28. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  29. def taking(bp: Body): Description

    Register the expected content of the body.

    Register the expected content of the body. Presence is NOT currently enforced.

  30. def taking(rp: RequestParameter[_]): Description

    Register a request parameter.

    Register a request parameter. Mandatory parameters are checked for each request, and a 400 returned if any are missing.

  31. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped