api

ApiHelp

object ApiHelp extends Controller

Documentation about API using swagger.

Linear Supertypes
Controller, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, BodyParsers, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. ApiHelp
  2. Controller
  3. Rendering
  4. RequestExtractors
  5. AcceptExtractors
  6. ContentTypes
  7. HeaderNames
  8. Status
  9. HttpProtocol
  10. BodyParsers
  11. Results
  12. AnyRef
  13. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Type Members

  1. class Status extends SimpleResult

    Definition Classes
    Results

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. val ACCEPT: String

    Definition Classes
    HeaderNames
  7. val ACCEPTED: Int

    Definition Classes
    Status
  8. val ACCEPT_CHARSET: String

    Definition Classes
    HeaderNames
  9. val ACCEPT_ENCODING: String

    Definition Classes
    HeaderNames
  10. val ACCEPT_LANGUAGE: String

    Definition Classes
    HeaderNames
  11. val ACCEPT_RANGES: String

    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String

    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_HEADERS: String

    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_ALLOW_METHODS: String

    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_ALLOW_ORIGIN: String

    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_EXPOSE_HEADERS: String

    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_MAX_AGE: String

    Definition Classes
    HeaderNames
  18. val ACCESS_CONTROL_REQUEST_HEADERS: String

    Definition Classes
    HeaderNames
  19. val ACCESS_CONTROL_REQUEST_METHOD: String

    Definition Classes
    HeaderNames
  20. val AGE: String

    Definition Classes
    HeaderNames
  21. val ALLOW: String

    Definition Classes
    HeaderNames
  22. val AUTHORIZATION: String

    Definition Classes
    HeaderNames
  23. val Accepted: Status

    Definition Classes
    Results
  24. val BAD_GATEWAY: Int

    Definition Classes
    Status
  25. val BAD_REQUEST: Int

    Definition Classes
    Status
  26. val BINARY: String

    Definition Classes
    ContentTypes
  27. val BadGateway: Status

    Definition Classes
    Results
  28. val BadRequest: Status

    Definition Classes
    Results
  29. val CACHE_CONTROL: String

    Definition Classes
    HeaderNames
  30. val CHUNKED: String

    Definition Classes
    HttpProtocol
  31. val CONFLICT: Int

    Definition Classes
    Status
  32. val CONNECTION: String

    Definition Classes
    HeaderNames
  33. val CONTENT_DISPOSITION: String

    Definition Classes
    HeaderNames
  34. val CONTENT_ENCODING: String

    Definition Classes
    HeaderNames
  35. val CONTENT_LANGUAGE: String

    Definition Classes
    HeaderNames
  36. val CONTENT_LENGTH: String

    Definition Classes
    HeaderNames
  37. val CONTENT_LOCATION: String

    Definition Classes
    HeaderNames
  38. val CONTENT_MD5: String

    Definition Classes
    HeaderNames
  39. val CONTENT_RANGE: String

    Definition Classes
    HeaderNames
  40. val CONTENT_TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  41. val CONTENT_TYPE: String

    Definition Classes
    HeaderNames
  42. val CONTINUE: Int

    Definition Classes
    Status
  43. val COOKIE: String

    Definition Classes
    HeaderNames
  44. val CREATED: Int

    Definition Classes
    Status
  45. def CSS(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  46. val Conflict: Status

    Definition Classes
    Results
  47. val Created: Status

    Definition Classes
    Results
  48. val DATE: String

    Definition Classes
    HeaderNames
  49. val ETAG: String

    Definition Classes
    HeaderNames
  50. def EVENT_STREAM(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  51. val EXPECT: String

    Definition Classes
    HeaderNames
  52. val EXPECTATION_FAILED: Int

    Definition Classes
    Status
  53. val EXPIRES: String

    Definition Classes
    HeaderNames
  54. val EntityTooLarge: Status

    Definition Classes
    Results
  55. val ExpectationFailed: Status

    Definition Classes
    Results
  56. val FAILED_DEPENDENCY: Int

    Definition Classes
    Status
  57. val FORBIDDEN: Int

    Definition Classes
    Status
  58. def FORM(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  59. val FOUND: Int

    Definition Classes
    Status
  60. val FROM: String

    Definition Classes
    HeaderNames
  61. val FailedDependency: Status

    Definition Classes
    Results
  62. val Forbidden: Status

    Definition Classes
    Results
  63. def Found(url: String): SimpleResult

    Definition Classes
    Results
  64. val GATEWAY_TIMEOUT: Int

    Definition Classes
    Status
  65. val GONE: Int

    Definition Classes
    Status
  66. val GatewayTimeout: Status

    Definition Classes
    Results
  67. val Gone: Status

    Definition Classes
    Results
  68. val HOST: String

    Definition Classes
    HeaderNames
  69. def HTML(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  70. val HTTP_1_0: String

    Definition Classes
    HttpProtocol
  71. val HTTP_1_1: String

    Definition Classes
    HttpProtocol
  72. val HTTP_VERSION_NOT_SUPPORTED: Int

    Definition Classes
    Status
  73. val HttpVersionNotSupported: Status

    Definition Classes
    Results
  74. val IF_MATCH: String

    Definition Classes
    HeaderNames
  75. val IF_MODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  76. val IF_NONE_MATCH: String

    Definition Classes
    HeaderNames
  77. val IF_RANGE: String

    Definition Classes
    HeaderNames
  78. val IF_UNMODIFIED_SINCE: String

    Definition Classes
    HeaderNames
  79. val INSUFFICIENT_STORAGE: Int

    Definition Classes
    Status
  80. val INTERNAL_SERVER_ERROR: Int

    Definition Classes
    Status
  81. val InsufficientStorage: Status

    Definition Classes
    Results
  82. val InternalServerError: Status

    Definition Classes
    Results
  83. def JAVASCRIPT(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  84. def JSON(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  85. val LAST_MODIFIED: String

    Definition Classes
    HeaderNames
  86. val LENGTH_REQUIRED: Int

    Definition Classes
    Status
  87. val LOCATION: String

    Definition Classes
    HeaderNames
  88. val LOCKED: Int

    Definition Classes
    Status
  89. val Locked: Status

    Definition Classes
    Results
  90. val MAX_FORWARDS: String

    Definition Classes
    HeaderNames
  91. val METHOD_NOT_ALLOWED: Int

    Definition Classes
    Status
  92. val MOVED_PERMANENTLY: Int

    Definition Classes
    Status
  93. val MULTIPLE_CHOICES: Int

    Definition Classes
    Status
  94. val MULTI_STATUS: Int

    Definition Classes
    Status
  95. val MethodNotAllowed: Status

    Definition Classes
    Results
  96. def MovedPermanently(url: String): SimpleResult

    Definition Classes
    Results
  97. val MultiStatus: Status

    Definition Classes
    Results
  98. val NON_AUTHORITATIVE_INFORMATION: Int

    Definition Classes
    Status
  99. val NOT_ACCEPTABLE: Int

    Definition Classes
    Status
  100. val NOT_FOUND: Int

    Definition Classes
    Status
  101. val NOT_IMPLEMENTED: Int

    Definition Classes
    Status
  102. val NOT_MODIFIED: Int

    Definition Classes
    Status
  103. val NO_CONTENT: Int

    Definition Classes
    Status
  104. val NoContent: SimpleResult

    Definition Classes
    Results
  105. val NonAuthoritativeInformation: Status

    Definition Classes
    Results
  106. val NotAcceptable: Status

    Definition Classes
    Results
  107. val NotFound: Status

    Definition Classes
    Results
  108. val NotImplemented: Status

    Definition Classes
    Results
  109. val NotModified: SimpleResult

    Definition Classes
    Results
  110. val OK: Int

    Definition Classes
    Status
  111. val ORIGIN: String

    Definition Classes
    HeaderNames
  112. val Ok: Status

    Definition Classes
    Results
  113. val PARTIAL_CONTENT: Int

    Definition Classes
    Status
  114. val PAYMENT_REQUIRED: Int

    Definition Classes
    Status
  115. val PRAGMA: String

    Definition Classes
    HeaderNames
  116. val PRECONDITION_FAILED: Int

    Definition Classes
    Status
  117. val PROXY_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  118. val PROXY_AUTHENTICATION_REQUIRED: Int

    Definition Classes
    Status
  119. val PROXY_AUTHORIZATION: String

    Definition Classes
    HeaderNames
  120. val PartialContent: Status

    Definition Classes
    Results
  121. val PreconditionFailed: Status

    Definition Classes
    Results
  122. val RANGE: String

    Definition Classes
    HeaderNames
  123. val REFERER: String

    Definition Classes
    HeaderNames
  124. val REQUESTED_RANGE_NOT_SATISFIABLE: Int

    Definition Classes
    Status
  125. val REQUEST_ENTITY_TOO_LARGE: Int

    Definition Classes
    Status
  126. val REQUEST_TIMEOUT: Int

    Definition Classes
    Status
  127. val REQUEST_URI_TOO_LONG: Int

    Definition Classes
    Status
  128. val RESET_CONTENT: Int

    Definition Classes
    Status
  129. val RETRY_AFTER: String

    Definition Classes
    HeaderNames
  130. def Redirect(call: Call): SimpleResult

    Definition Classes
    Results
  131. def Redirect(url: String, queryString: Map[String, Seq[String]], status: Int): SimpleResult

    Definition Classes
    Results
  132. def Redirect(url: String, status: Int): SimpleResult

    Definition Classes
    Results
  133. val RequestTimeout: Status

    Definition Classes
    Results
  134. val ResetContent: SimpleResult

    Definition Classes
    Results
  135. val SEE_OTHER: Int

    Definition Classes
    Status
  136. val SERVER: String

    Definition Classes
    HeaderNames
  137. val SERVICE_UNAVAILABLE: Int

    Definition Classes
    Status
  138. val SET_COOKIE: String

    Definition Classes
    HeaderNames
  139. val SET_COOKIE2: String

    Definition Classes
    HeaderNames
  140. val SWITCHING_PROTOCOLS: Int

    Definition Classes
    Status
  141. def SeeOther(url: String): SimpleResult

    Definition Classes
    Results
  142. val ServiceUnavailable: Status

    Definition Classes
    Results
  143. def Status(code: Int): Status

    Definition Classes
    Results
  144. val TE: String

    Definition Classes
    HeaderNames
  145. val TEMPORARY_REDIRECT: Int

    Definition Classes
    Status
  146. def TEXT(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  147. val TODO: Action[AnyContent]

    Definition Classes
    Controller
  148. val TOO_MANY_REQUEST: Int

    Definition Classes
    Status
  149. val TRAILER: String

    Definition Classes
    HeaderNames
  150. val TRANSFER_ENCODING: String

    Definition Classes
    HeaderNames
  151. def TemporaryRedirect(url: String): SimpleResult

    Definition Classes
    Results
  152. val TooManyRequest: Status

    Definition Classes
    Results
  153. val UNAUTHORIZED: Int

    Definition Classes
    Status
  154. val UNPROCESSABLE_ENTITY: Int

    Definition Classes
    Status
  155. val UNSUPPORTED_MEDIA_TYPE: Int

    Definition Classes
    Status
  156. val UPGRADE: String

    Definition Classes
    HeaderNames
  157. val USER_AGENT: String

    Definition Classes
    HeaderNames
  158. val USE_PROXY: Int

    Definition Classes
    Status
  159. val Unauthorized: Status

    Definition Classes
    Results
  160. val UnprocessableEntity: Status

    Definition Classes
    Results
  161. val UnsupportedMediaType: Status

    Definition Classes
    Results
  162. val UriTooLong: Status

    Definition Classes
    Results
  163. val VARY: String

    Definition Classes
    HeaderNames
  164. val VIA: String

    Definition Classes
    HeaderNames
  165. val WARNING: String

    Definition Classes
    HeaderNames
  166. val WWW_AUTHENTICATE: String

    Definition Classes
    HeaderNames
  167. def XML(implicit codec: Codec): String

    Definition Classes
    ContentTypes
  168. val X_FORWARDED_FOR: String

    Definition Classes
    HeaderNames
  169. val X_FORWARDED_HOST: String

    Definition Classes
    HeaderNames
  170. val X_FORWARDED_PORT: String

    Definition Classes
    HeaderNames
  171. val X_FORWARDED_PROTO: String

    Definition Classes
    HeaderNames
  172. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  173. def chunk(trailers: Option[Iteratee[Array[Byte], Seq[(String, String)]]]): Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  174. def chunk: Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  175. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  176. def dechunk: Enumeratee[Array[Byte], Array[Byte]]

    Definition Classes
    Results
  177. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  178. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  179. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  180. implicit def flash(implicit request: RequestHeader): Flash

    Definition Classes
    Controller
  181. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  182. def getResources(): Action[AnyContent]

    Used as entry point by swagger.

  183. def hashCode(): Int

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

    Definition Classes
    Any
  185. implicit def lang(implicit request: RequestHeader): Lang

    Definition Classes
    Controller
  186. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  189. def options(path: String): Action[AnyContent]

  190. object parse

    Definition Classes
    BodyParsers
  191. implicit def session(implicit request: RequestHeader): Session

    Definition Classes
    Controller
  192. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  193. def toString(): String

    Definition Classes
    AnyRef → Any
  194. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  197. def withCharset(mimeType: String)(implicit codec: Codec): String

    Definition Classes
    ContentTypes

Deprecated Value Members

  1. def Async(promise: Future[Result]): AsyncResult

    Definition Classes
    Results
    Annotations
    @deprecated
    Deprecated

    (Since version 2.2.0) Use Action.async to build async actions instead

Inherited from Controller

Inherited from Rendering

Inherited from RequestExtractors

Inherited from AcceptExtractors

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from play.api.http.Status

Inherited from HttpProtocol

Inherited from BodyParsers

Inherited from Results

Inherited from AnyRef

Inherited from Any

Ungrouped