controllers
ApiHelpController
Related Doc:
package controllers
object
ApiHelpController
extends
SwaggerBaseApiController
Linear Supertypes
SwaggerBaseApiController
,
Controller
,
Rendering
,
RequestExtractors
,
AcceptExtractors
,
ContentTypes
,
HeaderNames
,
play.api.http.Status
,
HttpProtocol
,
BodyParsers
,
Results
,
AnyRef
,
Any
Ordering
Alphabetic
By inheritance
Inherited
ApiHelpController
SwaggerBaseApiController
Controller
Rendering
RequestExtractors
AcceptExtractors
ContentTypes
HeaderNames
Status
HttpProtocol
BodyParsers
Results
AnyRef
Any
Hide All
Show all
Learn more about member selection
Visibility
Public
All
Type Members
class
Status
extends
Result
Definition Classes
Results
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
val
ACCEPT
:
String
Definition Classes
HeaderNames
val
ACCEPTED
:
Int
Definition Classes
Status
val
ACCEPT_CHARSET
:
String
Definition Classes
HeaderNames
val
ACCEPT_ENCODING
:
String
Definition Classes
HeaderNames
val
ACCEPT_LANGUAGE
:
String
Definition Classes
HeaderNames
val
ACCEPT_RANGES
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_ALLOW_CREDENTIALS
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_ALLOW_HEADERS
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_ALLOW_METHODS
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_ALLOW_ORIGIN
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_EXPOSE_HEADERS
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_MAX_AGE
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_REQUEST_HEADERS
:
String
Definition Classes
HeaderNames
val
ACCESS_CONTROL_REQUEST_METHOD
:
String
Definition Classes
HeaderNames
val
AGE
:
String
Definition Classes
HeaderNames
val
ALLOW
:
String
Definition Classes
HeaderNames
val
AUTHORIZATION
:
String
Definition Classes
HeaderNames
val
Accepted
:
Status
Definition Classes
Results
val
AccessControlAllowOrigin
: (
String
,
String
)
Attributes
protected
Definition Classes
SwaggerBaseApiController
val
BAD_GATEWAY
:
Int
Definition Classes
Status
val
BAD_REQUEST
:
Int
Definition Classes
Status
val
BINARY
:
String
Definition Classes
ContentTypes
val
BadGateway
:
Status
Definition Classes
Results
val
BadRequest
:
Status
Definition Classes
Results
val
CACHE_CONTROL
:
String
Definition Classes
HeaderNames
val
CACHE_MANIFEST
:
String
Definition Classes
ContentTypes
val
CHUNKED
:
String
Definition Classes
HttpProtocol
val
CONFLICT
:
Int
Definition Classes
Status
val
CONNECTION
:
String
Definition Classes
HeaderNames
val
CONTENT_DISPOSITION
:
String
Definition Classes
HeaderNames
val
CONTENT_ENCODING
:
String
Definition Classes
HeaderNames
val
CONTENT_LANGUAGE
:
String
Definition Classes
HeaderNames
val
CONTENT_LENGTH
:
String
Definition Classes
HeaderNames
val
CONTENT_LOCATION
:
String
Definition Classes
HeaderNames
val
CONTENT_MD5
:
String
Definition Classes
HeaderNames
val
CONTENT_RANGE
:
String
Definition Classes
HeaderNames
val
CONTENT_TRANSFER_ENCODING
:
String
Definition Classes
HeaderNames
val
CONTENT_TYPE
:
String
Definition Classes
HeaderNames
val
CONTINUE
:
Int
Definition Classes
Status
val
COOKIE
:
String
Definition Classes
HeaderNames
val
CREATED
:
Int
Definition Classes
Status
def
CSS
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
val
Conflict
:
Status
Definition Classes
Results
val
Created
:
Status
Definition Classes
Results
val
DATE
:
String
Definition Classes
HeaderNames
val
ETAG
:
String
Definition Classes
HeaderNames
def
EVENT_STREAM
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
val
EXPECT
:
String
Definition Classes
HeaderNames
val
EXPECTATION_FAILED
:
Int
Definition Classes
Status
val
EXPIRES
:
String
Definition Classes
HeaderNames
val
EntityTooLarge
:
Status
Definition Classes
Results
val
ExpectationFailed
:
Status
Definition Classes
Results
val
FAILED_DEPENDENCY
:
Int
Definition Classes
Status
val
FORBIDDEN
:
Int
Definition Classes
Status
def
FORM
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
val
FOUND
:
Int
Definition Classes
Status
val
FROM
:
String
Definition Classes
HeaderNames
val
FailedDependency
:
Status
Definition Classes
Results
val
Forbidden
:
Status
Definition Classes
Results
def
Found
(
url:
String
)
:
Result
Definition Classes
Results
val
GATEWAY_TIMEOUT
:
Int
Definition Classes
Status
val
GONE
:
Int
Definition Classes
Status
val
GatewayTimeout
:
Status
Definition Classes
Results
val
Gone
:
Status
Definition Classes
Results
val
HOST
:
String
Definition Classes
HeaderNames
def
HTML
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
val
HTTP_1_0
:
String
Definition Classes
HttpProtocol
val
HTTP_1_1
:
String
Definition Classes
HttpProtocol
val
HTTP_VERSION_NOT_SUPPORTED
:
Int
Definition Classes
Status
val
HttpVersionNotSupported
:
Status
Definition Classes
Results
val
IF_MATCH
:
String
Definition Classes
HeaderNames
val
IF_MODIFIED_SINCE
:
String
Definition Classes
HeaderNames
val
IF_NONE_MATCH
:
String
Definition Classes
HeaderNames
val
IF_RANGE
:
String
Definition Classes
HeaderNames
val
IF_UNMODIFIED_SINCE
:
String
Definition Classes
HeaderNames
val
INSUFFICIENT_STORAGE
:
Int
Definition Classes
Status
val
INTERNAL_SERVER_ERROR
:
Int
Definition Classes
Status
val
InsufficientStorage
:
Status
Definition Classes
Results
val
InternalServerError
:
Status
Definition Classes
Results
def
JAVASCRIPT
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
def
JSON
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
def
JsonResponse
(
data:
Any
)
:
Result
Attributes
protected
Definition Classes
SwaggerBaseApiController
val
LAST_MODIFIED
:
String
Definition Classes
HeaderNames
val
LENGTH_REQUIRED
:
Int
Definition Classes
Status
val
LOCATION
:
String
Definition Classes
HeaderNames
val
LOCKED
:
Int
Definition Classes
Status
val
Locked
:
Status
Definition Classes
Results
val
MAX_FORWARDS
:
String
Definition Classes
HeaderNames
val
METHOD_NOT_ALLOWED
:
Int
Definition Classes
Status
val
MOVED_PERMANENTLY
:
Int
Definition Classes
Status
val
MULTIPLE_CHOICES
:
Int
Definition Classes
Status
val
MULTI_STATUS
:
Int
Definition Classes
Status
val
MethodNotAllowed
:
Status
Definition Classes
Results
def
MovedPermanently
(
url:
String
)
:
Result
Definition Classes
Results
val
MultiStatus
:
Status
Definition Classes
Results
val
NON_AUTHORITATIVE_INFORMATION
:
Int
Definition Classes
Status
val
NOT_ACCEPTABLE
:
Int
Definition Classes
Status
val
NOT_FOUND
:
Int
Definition Classes
Status
val
NOT_IMPLEMENTED
:
Int
Definition Classes
Status
val
NOT_MODIFIED
:
Int
Definition Classes
Status
val
NO_CONTENT
:
Int
Definition Classes
Status
val
NoContent
:
Result
Definition Classes
Results
val
NonAuthoritativeInformation
:
Status
Definition Classes
Results
val
NotAcceptable
:
Status
Definition Classes
Results
val
NotFound
:
Status
Definition Classes
Results
val
NotImplemented
:
Status
Definition Classes
Results
val
NotModified
:
Result
Definition Classes
Results
val
OK
:
Int
Definition Classes
Status
val
ORIGIN
:
String
Definition Classes
HeaderNames
val
Ok
:
Status
Definition Classes
Results
val
PARTIAL_CONTENT
:
Int
Definition Classes
Status
val
PAYMENT_REQUIRED
:
Int
Definition Classes
Status
val
PRAGMA
:
String
Definition Classes
HeaderNames
val
PRECONDITION_FAILED
:
Int
Definition Classes
Status
val
PROXY_AUTHENTICATE
:
String
Definition Classes
HeaderNames
val
PROXY_AUTHENTICATION_REQUIRED
:
Int
Definition Classes
Status
val
PROXY_AUTHORIZATION
:
String
Definition Classes
HeaderNames
val
PartialContent
:
Status
Definition Classes
Results
val
PreconditionFailed
:
Status
Definition Classes
Results
val
RANGE
:
String
Definition Classes
HeaderNames
val
REFERER
:
String
Definition Classes
HeaderNames
val
REQUESTED_RANGE_NOT_SATISFIABLE
:
Int
Definition Classes
Status
val
REQUEST_ENTITY_TOO_LARGE
:
Int
Definition Classes
Status
val
REQUEST_TIMEOUT
:
Int
Definition Classes
Status
val
REQUEST_URI_TOO_LONG
:
Int
Definition Classes
Status
val
RESET_CONTENT
:
Int
Definition Classes
Status
val
RETRY_AFTER
:
String
Definition Classes
HeaderNames
def
Redirect
(
call:
Call
)
:
Result
Definition Classes
Results
def
Redirect
(
url:
String
,
queryString:
Map
[
String
,
Seq
[
String
]]
,
status:
Int
)
:
Result
Definition Classes
Results
def
Redirect
(
url:
String
,
status:
Int
)
:
Result
Definition Classes
Results
val
RequestTimeout
:
Status
Definition Classes
Results
val
ResetContent
:
Result
Definition Classes
Results
val
SEE_OTHER
:
Int
Definition Classes
Status
val
SERVER
:
String
Definition Classes
HeaderNames
val
SERVICE_UNAVAILABLE
:
Int
Definition Classes
Status
val
SET_COOKIE
:
String
Definition Classes
HeaderNames
val
SET_COOKIE2
:
String
Definition Classes
HeaderNames
val
SWITCHING_PROTOCOLS
:
Int
Definition Classes
Status
def
SeeOther
(
url:
String
)
:
Result
Definition Classes
Results
val
ServiceUnavailable
:
Status
Definition Classes
Results
def
Status
(
code:
Int
)
:
Status
Definition Classes
Results
val
TE
:
String
Definition Classes
HeaderNames
val
TEMPORARY_REDIRECT
:
Int
Definition Classes
Status
def
TEXT
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
val
TODO
:
Action
[
AnyContent
]
Definition Classes
Controller
val
TOO_MANY_REQUEST
:
Int
Definition Classes
Status
val
TRAILER
:
String
Definition Classes
HeaderNames
val
TRANSFER_ENCODING
:
String
Definition Classes
HeaderNames
def
TemporaryRedirect
(
url:
String
)
:
Result
Definition Classes
Results
val
TooManyRequest
:
Status
Definition Classes
Results
val
UNAUTHORIZED
:
Int
Definition Classes
Status
val
UNPROCESSABLE_ENTITY
:
Int
Definition Classes
Status
val
UNSUPPORTED_MEDIA_TYPE
:
Int
Definition Classes
Status
val
UPGRADE
:
String
Definition Classes
HeaderNames
val
USER_AGENT
:
String
Definition Classes
HeaderNames
val
USE_PROXY
:
Int
Definition Classes
Status
val
Unauthorized
:
Status
Definition Classes
Results
val
UnprocessableEntity
:
Status
Definition Classes
Results
val
UnsupportedMediaType
:
Status
Definition Classes
Results
val
UriTooLong
:
Status
Definition Classes
Results
val
VARY
:
String
Definition Classes
HeaderNames
val
VIA
:
String
Definition Classes
HeaderNames
val
WARNING
:
String
Definition Classes
HeaderNames
val
WWW_AUTHENTICATE
:
String
Definition Classes
HeaderNames
def
XML
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
val
X_FORWARDED_FOR
:
String
Definition Classes
HeaderNames
val
X_FORWARDED_HOST
:
String
Definition Classes
HeaderNames
val
X_FORWARDED_PORT
:
String
Definition Classes
HeaderNames
val
X_FORWARDED_PROTO
:
String
Definition Classes
HeaderNames
def
XmlResponse
(
data:
Any
)
:
Result
Attributes
protected
Definition Classes
SwaggerBaseApiController
final
def
asInstanceOf
[
T0
]
:
T0
Definition Classes
Any
def
chunk
(
trailers:
Option
[
Iteratee
[
Array
[
Byte
],
Seq
[(
String
,
String
)]]]
)
:
Enumeratee
[
Array
[
Byte
],
Array
[
Byte
]]
Definition Classes
Results
def
chunk
:
Enumeratee
[
Array
[
Byte
],
Array
[
Byte
]]
Definition Classes
Results
def
clone
()
:
AnyRef
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
...
)
def
dechunk
:
Enumeratee
[
Array
[
Byte
],
Array
[
Byte
]]
Definition Classes
Results
final
def
eq
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
def
equals
(
arg0:
Any
)
:
Boolean
Definition Classes
AnyRef → Any
def
finalize
()
:
Unit
Attributes
protected[
java.lang
]
Definition Classes
AnyRef
Annotations
@throws
(
classOf[java.lang.Throwable]
)
def
getApiListing
(
resourceName:
String
)
(
implicit
requestHeader:
RequestHeader
)
:
Option
[
ApiListing
]
Get detailed API/models for a given resource
Get detailed API/models for a given resource
Attributes
protected
Definition Classes
SwaggerBaseApiController
final
def
getClass
()
:
Class
[_]
Definition Classes
AnyRef → Any
def
getResource
(
path:
String
)
:
Action
[
AnyContent
]
def
getResourceListing
(
implicit
requestHeader:
RequestHeader
)
:
ResourceListing
Get a list of all top level resources
Get a list of all top level resources
Attributes
protected
Definition Classes
SwaggerBaseApiController
def
getResources
()
:
Action
[
AnyContent
]
def
hashCode
()
:
Int
Definition Classes
AnyRef → Any
final
def
isInstanceOf
[
T0
]
:
Boolean
Definition Classes
Any
def
jaxbContext
()
:
JAXBContext
Attributes
protected
Definition Classes
SwaggerBaseApiController
final
def
ne
(
arg0:
AnyRef
)
:
Boolean
Definition Classes
AnyRef
final
def
notify
()
:
Unit
Definition Classes
AnyRef
final
def
notifyAll
()
:
Unit
Definition Classes
AnyRef
implicit
def
request2flash
(
implicit
request:
RequestHeader
)
:
Flash
Definition Classes
Controller
implicit
def
request2lang
(
implicit
request:
RequestHeader
)
:
Lang
Definition Classes
Controller
implicit
def
request2session
(
implicit
request:
RequestHeader
)
:
Session
Definition Classes
Controller
def
returnValue
(
request:
Request
[_]
,
obj:
Any
)
:
Result
Attributes
protected
Definition Classes
SwaggerBaseApiController
def
returnXml
(
request:
Request
[_]
)
:
Boolean
Attributes
protected
Definition Classes
SwaggerBaseApiController
final
def
synchronized
[
T0
]
(
arg0: ⇒
T0
)
:
T0
Definition Classes
AnyRef
def
toJsonString
(
data:
Any
)
:
String
Definition Classes
SwaggerBaseApiController
def
toString
()
:
String
Definition Classes
AnyRef → Any
def
toXmlString
(
data:
Any
)
:
String
Definition Classes
SwaggerBaseApiController
final
def
wait
()
:
Unit
Definition Classes
AnyRef
Annotations
@throws
(
...
)
final
def
wait
(
arg0:
Long
,
arg1:
Int
)
:
Unit
Definition Classes
AnyRef
Annotations
@throws
(
...
)
final
def
wait
(
arg0:
Long
)
:
Unit
Definition Classes
AnyRef
Annotations
@throws
(
...
)
def
withCharset
(
mimeType:
String
)
(
implicit
codec:
Codec
)
:
String
Definition Classes
ContentTypes
Inherited from
SwaggerBaseApiController
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