Packages

c

controllers

ApiHelpController

class ApiHelpController extends AbstractController with SwaggerBaseApiController

Linear Supertypes
SwaggerBaseApiController, AbstractController, BaseController, BaseControllerHelpers, ControllerHelpers, RequestImplicits, Rendering, RequestExtractors, AcceptExtractors, ContentTypes, HeaderNames, play.api.http.Status, HttpProtocol, Results, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ApiHelpController
  2. SwaggerBaseApiController
  3. AbstractController
  4. BaseController
  5. BaseControllerHelpers
  6. ControllerHelpers
  7. RequestImplicits
  8. Rendering
  9. RequestExtractors
  10. AcceptExtractors
  11. ContentTypes
  12. HeaderNames
  13. Status
  14. HttpProtocol
  15. Results
  16. AnyRef
  17. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new ApiHelpController(components: ControllerComponents, swaggerPlugin: SwaggerPlugin)
    Annotations
    @Inject()

Type Members

  1. class Status extends Result
    Definition Classes
    Results

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. val ACCEPT: String
    Definition Classes
    HeaderNames
  5. val ACCEPTED: Int
    Definition Classes
    Status
  6. val ACCEPT_CHARSET: String
    Definition Classes
    HeaderNames
  7. val ACCEPT_ENCODING: String
    Definition Classes
    HeaderNames
  8. val ACCEPT_LANGUAGE: String
    Definition Classes
    HeaderNames
  9. val ACCEPT_RANGES: String
    Definition Classes
    HeaderNames
  10. val ACCESS_CONTROL_ALLOW_CREDENTIALS: String
    Definition Classes
    HeaderNames
  11. val ACCESS_CONTROL_ALLOW_HEADERS: String
    Definition Classes
    HeaderNames
  12. val ACCESS_CONTROL_ALLOW_METHODS: String
    Definition Classes
    HeaderNames
  13. val ACCESS_CONTROL_ALLOW_ORIGIN: String
    Definition Classes
    HeaderNames
  14. val ACCESS_CONTROL_EXPOSE_HEADERS: String
    Definition Classes
    HeaderNames
  15. val ACCESS_CONTROL_MAX_AGE: String
    Definition Classes
    HeaderNames
  16. val ACCESS_CONTROL_REQUEST_HEADERS: String
    Definition Classes
    HeaderNames
  17. val ACCESS_CONTROL_REQUEST_METHOD: String
    Definition Classes
    HeaderNames
  18. val AGE: String
    Definition Classes
    HeaderNames
  19. val ALLOW: String
    Definition Classes
    HeaderNames
  20. val AUTHORIZATION: String
    Definition Classes
    HeaderNames
  21. val Accepted: Status
    Definition Classes
    Results
  22. val AccessControlAllowOrigin: (String, String)
    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  23. def Action: ActionBuilder[Request, AnyContent]
    Definition Classes
    BaseController
  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 CACHE_MANIFEST: String
    Definition Classes
    ContentTypes
  31. val CHUNKED: String
    Definition Classes
    HttpProtocol
  32. val CONFLICT: Int
    Definition Classes
    Status
  33. val CONNECTION: String
    Definition Classes
    HeaderNames
  34. val CONTENT_DISPOSITION: String
    Definition Classes
    HeaderNames
  35. val CONTENT_ENCODING: String
    Definition Classes
    HeaderNames
  36. val CONTENT_LANGUAGE: String
    Definition Classes
    HeaderNames
  37. val CONTENT_LENGTH: String
    Definition Classes
    HeaderNames
  38. val CONTENT_LOCATION: String
    Definition Classes
    HeaderNames
  39. val CONTENT_MD5: String
    Definition Classes
    HeaderNames
  40. val CONTENT_RANGE: String
    Definition Classes
    HeaderNames
  41. val CONTENT_SECURITY_POLICY: String
    Definition Classes
    HeaderNames
  42. val CONTENT_SECURITY_POLICY_REPORT_ONLY: String
    Definition Classes
    HeaderNames
  43. val CONTENT_TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  44. val CONTENT_TYPE: String
    Definition Classes
    HeaderNames
  45. val CONTINUE: Int
    Definition Classes
    Status
  46. val COOKIE: String
    Definition Classes
    HeaderNames
  47. val CREATED: Int
    Definition Classes
    Status
  48. def CSS(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  49. val Conflict: Status
    Definition Classes
    Results
  50. val Continue: Result
    Definition Classes
    Results
  51. val Created: Status
    Definition Classes
    Results
  52. val DATE: String
    Definition Classes
    HeaderNames
  53. val ETAG: String
    Definition Classes
    HeaderNames
  54. def EVENT_STREAM(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  55. val EXPECT: String
    Definition Classes
    HeaderNames
  56. val EXPECTATION_FAILED: Int
    Definition Classes
    Status
  57. val EXPIRES: String
    Definition Classes
    HeaderNames
  58. val EntityTooLarge: Status
    Definition Classes
    Results
  59. val ExpectationFailed: Status
    Definition Classes
    Results
  60. val FAILED_DEPENDENCY: Int
    Definition Classes
    Status
  61. val FORBIDDEN: Int
    Definition Classes
    Status
  62. val FORM: String
    Definition Classes
    ContentTypes
  63. val FORWARDED: String
    Definition Classes
    HeaderNames
  64. val FOUND: Int
    Definition Classes
    Status
  65. val FROM: String
    Definition Classes
    HeaderNames
  66. val FailedDependency: Status
    Definition Classes
    Results
  67. val Forbidden: Status
    Definition Classes
    Results
  68. def Found(url: String): Result
    Definition Classes
    Results
  69. val GATEWAY_TIMEOUT: Int
    Definition Classes
    Status
  70. val GONE: Int
    Definition Classes
    Status
  71. val GatewayTimeout: Status
    Definition Classes
    Results
  72. val Gone: Status
    Definition Classes
    Results
  73. val HOST: String
    Definition Classes
    HeaderNames
  74. def HTML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  75. val HTTP_1_0: String
    Definition Classes
    HttpProtocol
  76. val HTTP_1_1: String
    Definition Classes
    HttpProtocol
  77. val HTTP_2_0: String
    Definition Classes
    HttpProtocol
  78. val HTTP_VERSION_NOT_SUPPORTED: Int
    Definition Classes
    Status
  79. val HttpVersionNotSupported: Status
    Definition Classes
    Results
  80. val IF_MATCH: String
    Definition Classes
    HeaderNames
  81. val IF_MODIFIED_SINCE: String
    Definition Classes
    HeaderNames
  82. val IF_NONE_MATCH: String
    Definition Classes
    HeaderNames
  83. val IF_RANGE: String
    Definition Classes
    HeaderNames
  84. val IF_UNMODIFIED_SINCE: String
    Definition Classes
    HeaderNames
  85. val IM_A_TEAPOT: Int
    Definition Classes
    Status
  86. val INSUFFICIENT_STORAGE: Int
    Definition Classes
    Status
  87. val INTERNAL_SERVER_ERROR: Int
    Definition Classes
    Status
  88. val ImATeapot: Status
    Definition Classes
    Results
  89. val InsufficientStorage: Status
    Definition Classes
    Results
  90. val InternalServerError: Status
    Definition Classes
    Results
  91. def JAVASCRIPT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  92. val JSON: String
    Definition Classes
    ContentTypes
  93. def JsonResponse(data: Any): Result
    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  94. val LAST_MODIFIED: String
    Definition Classes
    HeaderNames
  95. val LENGTH_REQUIRED: Int
    Definition Classes
    Status
  96. val LINK: String
    Definition Classes
    HeaderNames
  97. val LOCATION: String
    Definition Classes
    HeaderNames
  98. val LOCKED: Int
    Definition Classes
    Status
  99. val Locked: Status
    Definition Classes
    Results
  100. val MAX_FORWARDS: String
    Definition Classes
    HeaderNames
  101. val METHOD_NOT_ALLOWED: Int
    Definition Classes
    Status
  102. val MOVED_PERMANENTLY: Int
    Definition Classes
    Status
  103. val MULTIPLE_CHOICES: Int
    Definition Classes
    Status
  104. val MULTI_STATUS: Int
    Definition Classes
    Status
  105. val MethodNotAllowed: Status
    Definition Classes
    Results
  106. def MovedPermanently(url: String): Result
    Definition Classes
    Results
  107. val MultiStatus: Status
    Definition Classes
    Results
  108. val NETWORK_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  109. val NON_AUTHORITATIVE_INFORMATION: Int
    Definition Classes
    Status
  110. val NOT_ACCEPTABLE: Int
    Definition Classes
    Status
  111. val NOT_FOUND: Int
    Definition Classes
    Status
  112. val NOT_IMPLEMENTED: Int
    Definition Classes
    Status
  113. val NOT_MODIFIED: Int
    Definition Classes
    Status
  114. val NO_CONTENT: Int
    Definition Classes
    Status
  115. val NetworkAuthenticationRequired: Status
    Definition Classes
    Results
  116. val NoContent: Result
    Definition Classes
    Results
  117. val NonAuthoritativeInformation: Status
    Definition Classes
    Results
  118. val NotAcceptable: Status
    Definition Classes
    Results
  119. val NotFound: Status
    Definition Classes
    Results
  120. val NotImplemented: Status
    Definition Classes
    Results
  121. val NotModified: Result
    Definition Classes
    Results
  122. val OK: Int
    Definition Classes
    Status
  123. val ORIGIN: String
    Definition Classes
    HeaderNames
  124. val Ok: Status
    Definition Classes
    Results
  125. val PARTIAL_CONTENT: Int
    Definition Classes
    Status
  126. val PAYMENT_REQUIRED: Int
    Definition Classes
    Status
  127. val PERMANENT_REDIRECT: Int
    Definition Classes
    Status
  128. val PRAGMA: String
    Definition Classes
    HeaderNames
  129. val PRECONDITION_FAILED: Int
    Definition Classes
    Status
  130. val PRECONDITION_REQUIRED: Int
    Definition Classes
    Status
  131. val PROXY_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  132. val PROXY_AUTHENTICATION_REQUIRED: Int
    Definition Classes
    Status
  133. val PROXY_AUTHORIZATION: String
    Definition Classes
    HeaderNames
  134. val PartialContent: Status
    Definition Classes
    Results
  135. val PaymentRequired: Status
    Definition Classes
    Results
  136. def PermanentRedirect(url: String): Result
    Definition Classes
    Results
  137. val PreconditionFailed: Status
    Definition Classes
    Results
  138. val PreconditionRequired: Status
    Definition Classes
    Results
  139. val RANGE: String
    Definition Classes
    HeaderNames
  140. val REFERER: String
    Definition Classes
    HeaderNames
  141. val REFERRER_POLICY: String
    Definition Classes
    HeaderNames
  142. val REQUESTED_RANGE_NOT_SATISFIABLE: Int
    Definition Classes
    Status
  143. val REQUEST_ENTITY_TOO_LARGE: Int
    Definition Classes
    Status
  144. val REQUEST_HEADER_FIELDS_TOO_LARGE: Int
    Definition Classes
    Status
  145. val REQUEST_TIMEOUT: Int
    Definition Classes
    Status
  146. val REQUEST_URI_TOO_LONG: Int
    Definition Classes
    Status
  147. val RESET_CONTENT: Int
    Definition Classes
    Status
  148. val RETRY_AFTER: String
    Definition Classes
    HeaderNames
  149. def Redirect(call: Call, status: Int): Result
    Definition Classes
    Results
  150. def Redirect(call: Call): Result
    Definition Classes
    Results
  151. def Redirect(url: String, queryStringParams: Map[String, Seq[String]], status: Int): Result
    Definition Classes
    Results
  152. def Redirect(url: String, statusCode: Int): Result
    Definition Classes
    Results
  153. val RequestHeaderFieldsTooLarge: Status
    Definition Classes
    Results
  154. val RequestTimeout: Status
    Definition Classes
    Results
  155. val ResetContent: Result
    Definition Classes
    Results
  156. val SEE_OTHER: Int
    Definition Classes
    Status
  157. val SERVER: String
    Definition Classes
    HeaderNames
  158. val SERVICE_UNAVAILABLE: Int
    Definition Classes
    Status
  159. val SET_COOKIE: String
    Definition Classes
    HeaderNames
  160. val SET_COOKIE2: String
    Definition Classes
    HeaderNames
  161. val STRICT_TRANSPORT_SECURITY: String
    Definition Classes
    HeaderNames
  162. val SWITCHING_PROTOCOLS: Int
    Definition Classes
    Status
  163. def SeeOther(url: String): Result
    Definition Classes
    Results
  164. val ServiceUnavailable: Status
    Definition Classes
    Results
  165. def Status(code: Int): Status
    Definition Classes
    Results
  166. val SwitchingProtocols: Result
    Definition Classes
    Results
  167. val TE: String
    Definition Classes
    HeaderNames
  168. val TEMPORARY_REDIRECT: Int
    Definition Classes
    Status
  169. def TEXT(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  170. lazy val TODO: Action[AnyContent]
    Definition Classes
    ControllerHelpers
  171. val TOO_MANY_REQUESTS: Int
    Definition Classes
    Status
  172. val TRAILER: String
    Definition Classes
    HeaderNames
  173. val TRANSFER_ENCODING: String
    Definition Classes
    HeaderNames
  174. def TemporaryRedirect(url: String): Result
    Definition Classes
    Results
  175. val TooManyRequests: Status
    Definition Classes
    Results
  176. val UNAUTHORIZED: Int
    Definition Classes
    Status
  177. val UNPROCESSABLE_ENTITY: Int
    Definition Classes
    Status
  178. val UNSUPPORTED_MEDIA_TYPE: Int
    Definition Classes
    Status
  179. val UPGRADE: String
    Definition Classes
    HeaderNames
  180. val UPGRADE_REQUIRED: Int
    Definition Classes
    Status
  181. val USER_AGENT: String
    Definition Classes
    HeaderNames
  182. val USE_PROXY: Int
    Definition Classes
    Status
  183. val Unauthorized: Status
    Definition Classes
    Results
  184. val UnprocessableEntity: Status
    Definition Classes
    Results
  185. val UnsupportedMediaType: Status
    Definition Classes
    Results
  186. val UriTooLong: Status
    Definition Classes
    Results
  187. val VARY: String
    Definition Classes
    HeaderNames
  188. val VIA: String
    Definition Classes
    HeaderNames
  189. val WARNING: String
    Definition Classes
    HeaderNames
  190. val WWW_AUTHENTICATE: String
    Definition Classes
    HeaderNames
  191. def XHTML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  192. def XML(implicit codec: Codec): String
    Definition Classes
    ContentTypes
  193. val X_CONTENT_SECURITY_POLICY_NONCE_HEADER: String
    Definition Classes
    HeaderNames
  194. val X_CONTENT_TYPE_OPTIONS: String
    Definition Classes
    HeaderNames
  195. val X_FORWARDED_FOR: String
    Definition Classes
    HeaderNames
  196. val X_FORWARDED_HOST: String
    Definition Classes
    HeaderNames
  197. val X_FORWARDED_PORT: String
    Definition Classes
    HeaderNames
  198. val X_FORWARDED_PROTO: String
    Definition Classes
    HeaderNames
  199. val X_FRAME_OPTIONS: String
    Definition Classes
    HeaderNames
  200. val X_PERMITTED_CROSS_DOMAIN_POLICIES: String
    Definition Classes
    HeaderNames
  201. val X_REQUESTED_WITH: String
    Definition Classes
    HeaderNames
  202. val X_XSS_PROTECTION: String
    Definition Classes
    HeaderNames
  203. def XmlResponse(data: Any): Result
    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  204. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  205. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  206. val controllerComponents: ControllerComponents
    Attributes
    protected
    Definition Classes
    AbstractController → BaseControllerHelpers
  207. def defaultExecutionContext: ExecutionContext
    Definition Classes
    BaseControllerHelpers
  208. implicit lazy val defaultFormBinding: FormBinding
    Definition Classes
    BaseControllerHelpers
  209. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  210. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  211. implicit def fileMimeTypes: FileMimeTypes
    Definition Classes
    BaseControllerHelpers
  212. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  213. def getApiListing(resourceName: String, host: String)(implicit requestHeader: RequestHeader): Swagger

    Get detailed API/models for a given resource

    Get detailed API/models for a given resource

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  214. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  215. def getResource(path: String): Action[AnyContent]
  216. def getResourceListing(host: String)(implicit requestHeader: RequestHeader): Swagger

    Get a list of all top level resources

    Get a list of all top level resources

    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  217. def getResources: Action[AnyContent]
  218. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  219. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  220. implicit def messagesApi: MessagesApi
    Definition Classes
    BaseControllerHelpers
  221. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  222. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  223. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  224. def parse: PlayBodyParsers
    Definition Classes
    BaseControllerHelpers
  225. implicit def request2flash(implicit request: RequestHeader): Flash
    Definition Classes
    RequestImplicits
  226. implicit def request2session(implicit request: RequestHeader): Session
    Definition Classes
    RequestImplicits
  227. def returnValue(request: Request[_], obj: Any): Result
    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  228. def returnXml(request: Request[_]): Boolean
    Attributes
    protected
    Definition Classes
    SwaggerBaseApiController
  229. implicit def supportedLangs: Langs
    Definition Classes
    BaseControllerHelpers
  230. val swaggerPlugin: SwaggerPlugin
  231. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  232. def toJsonString(data: Any): String
    Definition Classes
    SwaggerBaseApiController
  233. def toString(): String
    Definition Classes
    AnyRef → Any
  234. def toXmlString(data: Any): String
    Definition Classes
    SwaggerBaseApiController
  235. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  236. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  237. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  238. def withCharset(mimeType: String)(implicit codec: Codec): String
    Definition Classes
    ContentTypes

Inherited from AbstractController

Inherited from BaseController

Inherited from BaseControllerHelpers

Inherited from ControllerHelpers

Inherited from RequestImplicits

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 Results

Inherited from AnyRef

Inherited from Any

Ungrouped