controllers

ApiHelpController

object ApiHelpController extends SwaggerBaseApiController

This controller exposes swagger compatiable help apis.
The routing for the two apis supported by this controller is automatically injected by SwaggerPlugin

Since

10/9/11 4:37 PM

Linear Supertypes
SwaggerBaseApiController, Controller, ContentTypes, HeaderNames, Status, BodyParsers, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. ApiHelpController
  2. SwaggerBaseApiController
  3. Controller
  4. ContentTypes
  5. HeaderNames
  6. Status
  7. BodyParsers
  8. Results
  9. AnyRef
  10. Any
Visibility
  1. Public
  2. All

Value Members

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

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

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

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

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

    Attributes
    final
    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 AGE : String

    Definition Classes
    HeaderNames
  13. val ALLOW : String

    Definition Classes
    HeaderNames
  14. val AUTHORIZATION : String

    Definition Classes
    HeaderNames
  15. val Accepted : Status

    Definition Classes
    Results
  16. val AccessControlAllowOrigin : (String, String)

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  17. def Async (promise: Promise[Result]): AsyncResult

    Definition Classes
    Results
  18. val BAD_GATEWAY : Int

    Definition Classes
    Status
  19. val BAD_REQUEST : Int

    Definition Classes
    Status
  20. val BINARY : String

    Definition Classes
    ContentTypes
  21. val BadRequest : Status

    Definition Classes
    Results
  22. val CACHE_CONTROL : String

    Definition Classes
    HeaderNames
  23. val CONFLICT : Int

    Definition Classes
    Status
  24. val CONNECTION : String

    Definition Classes
    HeaderNames
  25. val CONTENT_DISPOSITION : String

    Definition Classes
    HeaderNames
  26. val CONTENT_ENCODING : String

    Definition Classes
    HeaderNames
  27. val CONTENT_LANGUAGE : String

    Definition Classes
    HeaderNames
  28. val CONTENT_LENGTH : String

    Definition Classes
    HeaderNames
  29. val CONTENT_LOCATION : String

    Definition Classes
    HeaderNames
  30. val CONTENT_MD5 : String

    Definition Classes
    HeaderNames
  31. val CONTENT_RANGE : String

    Definition Classes
    HeaderNames
  32. val CONTENT_TRANSFER_ENCODING : String

    Definition Classes
    HeaderNames
  33. val CONTENT_TYPE : String

    Definition Classes
    HeaderNames
  34. val CONTINUE : Int

    Definition Classes
    Status
  35. val COOKIE : String

    Definition Classes
    HeaderNames
  36. val CREATED : Int

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

    Definition Classes
    ContentTypes
  38. val Conflict : Status

    Definition Classes
    Results
  39. val Created : Status

    Definition Classes
    Results
  40. val DATE : String

    Definition Classes
    HeaderNames
  41. val ETAG : String

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

    Definition Classes
    ContentTypes
  43. val EXPECT : String

    Definition Classes
    HeaderNames
  44. val EXPECTATION_FAILED : Int

    Definition Classes
    Status
  45. val EXPIRES : String

    Definition Classes
    HeaderNames
  46. val EntityTooLarge : Status

    Definition Classes
    Results
  47. val ExpectationFailed : Status

    Definition Classes
    Results
  48. val FORBIDDEN : Int

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

    Definition Classes
    ContentTypes
  50. val FOUND : Int

    Definition Classes
    Status
  51. val FROM : String

    Definition Classes
    HeaderNames
  52. val Forbidden : Status

    Definition Classes
    Results
  53. def Found (url: String): SimpleResult[EmptyContent]

    Definition Classes
    Results
  54. val GATEWAY_TIMEOUT : Int

    Definition Classes
    Status
  55. val GONE : Int

    Definition Classes
    Status
  56. val Gone : Status

    Definition Classes
    Results
  57. val HOST : String

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

    Definition Classes
    ContentTypes
  59. val HTTP_VERSION_NOT_SUPPORTED : Int

    Definition Classes
    Status
  60. val IF_MATCH : String

    Definition Classes
    HeaderNames
  61. val IF_MODIFIED_SINCE : String

    Definition Classes
    HeaderNames
  62. val IF_NONE_MATCH : String

    Definition Classes
    HeaderNames
  63. val IF_RANGE : String

    Definition Classes
    HeaderNames
  64. val IF_UNMODIFIED_SINCE : String

    Definition Classes
    HeaderNames
  65. val INTERNAL_SERVER_ERROR : Int

    Definition Classes
    Status
  66. val InternalServerError : Status

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

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

    Definition Classes
    ContentTypes
  69. def JsonResponse (data: Any): PlainResult

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  70. val LAST_MODIFIED : String

    Definition Classes
    HeaderNames
  71. val LENGTH_REQUIRED : Int

    Definition Classes
    Status
  72. val LOCATION : String

    Definition Classes
    HeaderNames
  73. val MAX_FORWARDS : String

    Definition Classes
    HeaderNames
  74. val METHOD_NOT_ALLOWED : Int

    Definition Classes
    Status
  75. val MOVED_PERMANENTLY : Int

    Definition Classes
    Status
  76. val MULTIPLE_CHOICES : Int

    Definition Classes
    Status
  77. val MethodNotAllowed : Status

    Definition Classes
    Results
  78. def MovedPermanently (url: String): SimpleResult[EmptyContent]

    Definition Classes
    Results
  79. val NON_AUTHORITATIVE_INFORMATION : Int

    Definition Classes
    Status
  80. val NOT_ACCEPTABLE : Int

    Definition Classes
    Status
  81. val NOT_FOUND : Int

    Definition Classes
    Status
  82. val NOT_IMPLEMENTED : Int

    Definition Classes
    Status
  83. val NOT_MODIFIED : Int

    Definition Classes
    Status
  84. val NO_CONTENT : Int

    Definition Classes
    Status
  85. val NoContent : SimpleResult[EmptyContent]

    Definition Classes
    Results
  86. val NonAuthoritativeInformation : Status

    Definition Classes
    Results
  87. val NotAcceptable : Status

    Definition Classes
    Results
  88. val NotFound : Status

    Definition Classes
    Results
  89. val NotImplemented : Status

    Definition Classes
    Results
  90. val NotModified : SimpleResult[EmptyContent]

    Definition Classes
    Results
  91. val OK : Int

    Definition Classes
    Status
  92. val Ok : Status

    Definition Classes
    Results
  93. val PARTIAL_CONTENT : Int

    Definition Classes
    Status
  94. val PAYMENT_REQUIRED : Int

    Definition Classes
    Status
  95. val PRAGMA : String

    Definition Classes
    HeaderNames
  96. val PRECONDITION_FAILED : Int

    Definition Classes
    Status
  97. val PROXY_AUTHENTICATE : String

    Definition Classes
    HeaderNames
  98. val PROXY_AUTHENTICATION_REQUIRED : Int

    Definition Classes
    Status
  99. val PROXY_AUTHORIZATION : String

    Definition Classes
    HeaderNames
  100. val PartialContent : Status

    Definition Classes
    Results
  101. val PreconditionFailed : Status

    Definition Classes
    Results
  102. val RANGE : String

    Definition Classes
    HeaderNames
  103. val REFERER : String

    Definition Classes
    HeaderNames
  104. val REQUESTED_RANGE_NOT_SATISFIABLE : Int

    Definition Classes
    Status
  105. val REQUEST_ENTITY_TOO_LARGE : Int

    Definition Classes
    Status
  106. val REQUEST_TIMEOUT : Int

    Definition Classes
    Status
  107. val REQUEST_URI_TOO_LONG : Int

    Definition Classes
    Status
  108. val RESET_CONTENT : Int

    Definition Classes
    Status
  109. val RETRY_AFTER : String

    Definition Classes
    HeaderNames
  110. def Redirect (call: Call): SimpleResult[EmptyContent]

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

    Definition Classes
    Results
  112. def Redirect (url: String, status: Int): SimpleResult[EmptyContent]

    Definition Classes
    Results
  113. val RequestTimeout : Status

    Definition Classes
    Results
  114. val ResetContent : SimpleResult[EmptyContent]

    Definition Classes
    Results
  115. val SEE_OTHER : Int

    Definition Classes
    Status
  116. val SERVER : String

    Definition Classes
    HeaderNames
  117. val SERVICE_UNAVAILABLE : Int

    Definition Classes
    Status
  118. val SET_COOKIE : String

    Definition Classes
    HeaderNames
  119. val SET_COOKIE2 : String

    Definition Classes
    HeaderNames
  120. val SWITCHING_PROTOCOLS : Int

    Definition Classes
    Status
  121. def SeeOther (url: String): SimpleResult[EmptyContent]

    Definition Classes
    Results
  122. val ServiceUnavailable : Status

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

    Definition Classes
    Results
  124. val TE : String

    Definition Classes
    HeaderNames
  125. val TEMPORARY_REDIRECT : Int

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

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

    Definition Classes
    Controller
  128. val TOO_MANY_REQUEST : Int

    Definition Classes
    Status
  129. val TRAILER : String

    Definition Classes
    HeaderNames
  130. val TRANSFER_ENCODING : String

    Definition Classes
    HeaderNames
  131. def TemporaryRedirect (url: String): SimpleResult[EmptyContent]

    Definition Classes
    Results
  132. val TooManyRequest : Status

    Definition Classes
    Results
  133. val UNAUTHORIZED : Int

    Definition Classes
    Status
  134. val UNSUPPORTED_MEDIA_TYPE : Int

    Definition Classes
    Status
  135. val UPGRADE : String

    Definition Classes
    HeaderNames
  136. val USER_AGENT : String

    Definition Classes
    HeaderNames
  137. val USE_PROXY : Int

    Definition Classes
    Status
  138. val Unauthorized : Status

    Definition Classes
    Results
  139. val UnsupportedMediaType : Status

    Definition Classes
    Results
  140. val UriTooLong : Status

    Definition Classes
    Results
  141. val VARY : String

    Definition Classes
    HeaderNames
  142. val VIA : String

    Definition Classes
    HeaderNames
  143. val WARNING : String

    Definition Classes
    HeaderNames
  144. val WWW_AUTHENTICATE : String

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

    Definition Classes
    ContentTypes
  146. def XmlResponse (o: Any): PlainResult

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  147. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  148. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  149. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  150. def equals (arg0: Any): Boolean

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

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

    Attributes
    implicit
    Definition Classes
    Controller
  153. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  154. def getResource (path: String): Action[AnyContent]

  155. def getResources (): Action[AnyContent]

  156. def hashCode (): Int

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

    Attributes
    final
    Definition Classes
    Any
  158. def jaxbContext (): JAXBContext

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  159. implicit def lang (implicit request: RequestHeader): Lang

    Attributes
    implicit
    Definition Classes
    Controller
  160. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  161. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  162. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  163. val ok : String

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  164. def returnValue (request: play.api.mvc.Request[_], obj: Any): Result

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  165. def returnXml (request: play.api.mvc.Request[_]): Boolean

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  166. implicit def session (implicit request: RequestHeader): Session

    Attributes
    implicit
    Definition Classes
    Controller
  167. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  168. def toString (): String

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

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

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

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from SwaggerBaseApiController

Inherited from Controller

Inherited from ContentTypes

Inherited from HeaderNames

Inherited from Status

Inherited from BodyParsers

Inherited from Results

Inherited from AnyRef

Inherited from Any